8 * Class representing a MediaWiki article and history.
10 * See design.txt for an overview.
11 * Note: edit user interface and cache support functions have been
12 * moved to separate EditPage and HTMLFileCache classes.
19 var $mComment = ''; //!<
21 var $mContentLoaded = false; //!<
22 var $mCounter = -1; //!< Not loaded
23 var $mCurID = -1; //!< Not loaded
24 var $mDataLoaded = false; //!<
25 var $mForUpdate = false; //!<
26 var $mGoodAdjustment = 0; //!<
27 var $mIsRedirect = false; //!<
28 var $mLatest = false; //!<
31 var $mPreparedEdit = false; //!< Title object if set
32 var $mRedirectedFrom = null; //!< Title object if set
33 var $mRedirectTarget = null; //!< Title object if set
34 var $mRedirectUrl = false; //!<
35 var $mRevIdFetched = 0; //!<
37 var $mTimestamp = ''; //!<
39 var $mTotalAdjustment = 0; //!<
40 var $mTouched = '19700101000000'; //!<
41 var $mUser = -1; //!< Not loaded
42 var $mUserText = ''; //!<
43 var $mParserOptions; //!<
44 var $mParserOutput; //!<
48 * Constructor and clear the article
49 * @param $title Reference to a Title object.
50 * @param $oldId Integer revision ID, null to fetch from request, zero for current
52 public function __construct( Title
$title, $oldId = null ) {
53 $this->mTitle
=& $title;
54 $this->mOldId
= $oldId;
58 * Constructor from an article article
59 * @param $id The article ID to load
61 public static function newFromID( $id ) {
62 $t = Title
::newFromID( $id );
63 return $t == null ?
null : new Article( $t );
67 * Tell the page view functions that this view was redirected
68 * from another page on the wiki.
69 * @param $from Title object.
71 public function setRedirectedFrom( $from ) {
72 $this->mRedirectedFrom
= $from;
76 * If this page is a redirect, get its target
78 * The target will be fetched from the redirect table if possible.
79 * If this page doesn't have an entry there, call insertRedirect()
80 * @return mixed Title object, or null if this page is not a redirect
82 public function getRedirectTarget() {
83 if( !$this->mTitle ||
!$this->mTitle
->isRedirect() )
85 if( !is_null($this->mRedirectTarget
) )
86 return $this->mRedirectTarget
;
87 # Query the redirect table
88 $dbr = wfGetDB( DB_SLAVE
);
89 $row = $dbr->selectRow( 'redirect',
90 array('rd_namespace', 'rd_title'),
91 array('rd_from' => $this->getID() ),
95 return $this->mRedirectTarget
= Title
::makeTitle($row->rd_namespace
, $row->rd_title
);
97 # This page doesn't have an entry in the redirect table
98 return $this->mRedirectTarget
= $this->insertRedirect();
102 * Insert an entry for this page into the redirect table.
104 * Don't call this function directly unless you know what you're doing.
105 * @return Title object
107 public function insertRedirect() {
108 $retval = Title
::newFromRedirect( $this->getContent() );
112 $dbw = wfGetDB( DB_MASTER
);
113 $dbw->replace( 'redirect', array('rd_from'),
115 'rd_from' => $this->getID(),
116 'rd_namespace' => $retval->getNamespace(),
117 'rd_title' => $retval->getDBkey()
125 * Get the Title object this page redirects to
127 * @return mixed false, Title of in-wiki target, or string with URL
129 public function followRedirect() {
130 $text = $this->getContent();
131 return $this->followRedirectText( $text );
135 * Get the Title object this text redirects to
137 * @return mixed false, Title of in-wiki target, or string with URL
139 public function followRedirectText( $text ) {
140 $rt = Title
::newFromRedirectRecurse( $text ); // recurse through to only get the final target
141 # process if title object is valid and not special:userlogout
143 if( $rt->getInterwiki() != '' ) {
144 if( $rt->isLocal() ) {
145 // Offsite wikis need an HTTP redirect.
147 // This can be hard to reverse and may produce loops,
148 // so they may be disabled in the site configuration.
149 $source = $this->mTitle
->getFullURL( 'redirect=no' );
150 return $rt->getFullURL( 'rdfrom=' . urlencode( $source ) );
153 if( $rt->getNamespace() == NS_SPECIAL
) {
154 // Gotta handle redirects to special pages differently:
155 // Fill the HTTP response "Location" header and ignore
156 // the rest of the page we're on.
158 // This can be hard to reverse, so they may be disabled.
159 if( $rt->isSpecial( 'Userlogout' ) ) {
162 return $rt->getFullURL();
168 // No or invalid redirect
173 * get the title object of the article
175 public function getTitle() {
176 return $this->mTitle
;
183 public function clear() {
184 $this->mDataLoaded
= false;
185 $this->mContentLoaded
= false;
187 $this->mCurID
= $this->mUser
= $this->mCounter
= -1; # Not loaded
188 $this->mRedirectedFrom
= null; # Title object if set
189 $this->mRedirectTarget
= null; # Title object if set
191 $this->mTimestamp
= $this->mComment
= '';
192 $this->mGoodAdjustment
= $this->mTotalAdjustment
= 0;
193 $this->mTouched
= '19700101000000';
194 $this->mForUpdate
= false;
195 $this->mIsRedirect
= false;
196 $this->mRevIdFetched
= 0;
197 $this->mRedirectUrl
= false;
198 $this->mLatest
= false;
199 $this->mPreparedEdit
= false;
203 * Note that getContent/loadContent do not follow redirects anymore.
204 * If you need to fetch redirectable content easily, try
205 * the shortcut in Article::followContent()
207 * @return Return the text of this revision
209 public function getContent() {
210 global $wgUser, $wgContLang, $wgOut, $wgMessageCache;
211 wfProfileIn( __METHOD__
);
212 if( $this->getID() === 0 ) {
213 # If this is a MediaWiki:x message, then load the messages
214 # and return the message value for x.
215 if( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
216 # If this is a system message, get the default text.
217 list( $message, $lang ) = $wgMessageCache->figureMessage( $wgContLang->lcfirst( $this->mTitle
->getText() ) );
218 $wgMessageCache->loadAllMessages( $lang );
219 $text = wfMsgGetKey( $message, false, $lang, false );
220 if( wfEmptyMsg( $message, $text ) )
223 $text = wfMsgExt( $wgUser->isLoggedIn() ?
'noarticletext' : 'noarticletextanon', 'parsemag' );
225 wfProfileOut( __METHOD__
);
228 $this->loadContent();
229 wfProfileOut( __METHOD__
);
230 return $this->mContent
;
235 * Get the text of the current revision. No side-effects...
237 * @return Return the text of the current revision
239 public function getRawText() {
240 // Check process cache for current revision
241 if( $this->mContentLoaded
&& $this->mOldId
== 0 ) {
242 return $this->mContent
;
244 $rev = Revision
::newFromTitle( $this->mTitle
);
245 $text = $rev ?
$rev->getRawText() : false;
250 * This function returns the text of a section, specified by a number ($section).
251 * A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
252 * the first section before any such heading (section 0).
254 * If a section contains subsections, these are also returned.
256 * @param $text String: text to look in
257 * @param $section Integer: section number
258 * @return string text of the requested section
261 public function getSection( $text, $section ) {
263 return $wgParser->getSection( $text, $section );
267 * Get the text that needs to be saved in order to undo all revisions
268 * between $undo and $undoafter. Revisions must belong to the same page,
269 * must exist and must not be deleted
270 * @param $undo Revision
271 * @param $undoafter Revision Must be an earlier revision than $undo
272 * @return mixed string on success, false on failure
274 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
275 $undo_text = $undo->getText();
276 $undoafter_text = $undoafter->getText();
277 $cur_text = $this->getContent();
278 if ( $cur_text == $undo_text ) {
279 # No use doing a merge if it's just a straight revert.
280 return $undoafter_text;
283 if ( !wfMerge( $undo_text, $undoafter_text, $cur_text, $undone_text ) )
289 * @return int The oldid of the article that is to be shown, 0 for the
292 public function getOldID() {
293 if( is_null( $this->mOldId
) ) {
294 $this->mOldId
= $this->getOldIDFromRequest();
296 return $this->mOldId
;
300 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
302 * @return int The old id for the request
304 public function getOldIDFromRequest() {
306 $this->mRedirectUrl
= false;
307 $oldid = $wgRequest->getVal( 'oldid' );
308 if( isset( $oldid ) ) {
309 $oldid = intval( $oldid );
310 if( $wgRequest->getVal( 'direction' ) == 'next' ) {
311 $nextid = $this->mTitle
->getNextRevisionID( $oldid );
315 $this->mRedirectUrl
= $this->mTitle
->getFullURL( 'redirect=no' );
317 } elseif( $wgRequest->getVal( 'direction' ) == 'prev' ) {
318 $previd = $this->mTitle
->getPreviousRevisionID( $oldid );
331 * Load the revision (including text) into this object
333 function loadContent() {
334 if( $this->mContentLoaded
) return;
335 wfProfileIn( __METHOD__
);
337 $oldid = $this->getOldID();
338 # Pre-fill content with error message so that if something
339 # fails we'll have something telling us what we intended.
340 $this->mOldId
= $oldid;
341 $this->fetchContent( $oldid );
342 wfProfileOut( __METHOD__
);
347 * Fetch a page record with the given conditions
348 * @param $dbr Database object
349 * @param $conditions Array
351 protected function pageData( $dbr, $conditions ) {
365 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
366 $row = $dbr->selectRow(
372 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
377 * @param $dbr Database object
378 * @param $title Title object
380 public function pageDataFromTitle( $dbr, $title ) {
381 return $this->pageData( $dbr, array(
382 'page_namespace' => $title->getNamespace(),
383 'page_title' => $title->getDBkey() ) );
387 * @param $dbr Database
390 protected function pageDataFromId( $dbr, $id ) {
391 return $this->pageData( $dbr, array( 'page_id' => $id ) );
395 * Set the general counter, title etc data loaded from
398 * @param $data Database row object or "fromdb"
400 public function loadPageData( $data = 'fromdb' ) {
401 if( $data === 'fromdb' ) {
402 $dbr = wfGetDB( DB_MASTER
);
403 $data = $this->pageDataFromId( $dbr, $this->getId() );
406 $lc = LinkCache
::singleton();
408 $lc->addGoodLinkObj( $data->page_id
, $this->mTitle
, $data->page_len
, $data->page_is_redirect
);
410 $this->mTitle
->mArticleID
= intval( $data->page_id
);
412 # Old-fashioned restrictions
413 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
415 $this->mCounter
= intval( $data->page_counter
);
416 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
417 $this->mIsRedirect
= intval( $data->page_is_redirect
);
418 $this->mLatest
= intval( $data->page_latest
);
420 if( is_object( $this->mTitle
) ) {
421 $lc->addBadLinkObj( $this->mTitle
);
423 $this->mTitle
->mArticleID
= 0;
426 $this->mDataLoaded
= true;
430 * Get text of an article from database
431 * Does *NOT* follow redirects.
432 * @param $oldid Int: 0 for whatever the latest revision is
435 function fetchContent( $oldid = 0 ) {
436 if( $this->mContentLoaded
) {
437 return $this->mContent
;
440 $dbr = wfGetDB( DB_MASTER
);
442 # Pre-fill content with error message so that if something
443 # fails we'll have something telling us what we intended.
444 $t = $this->mTitle
->getPrefixedText();
445 $d = $oldid ?
wfMsgExt( 'missingarticle-rev', array( 'escape' ), $oldid ) : '';
446 $this->mContent
= wfMsg( 'missing-article', $t, $d ) ;
449 $revision = Revision
::newFromId( $oldid );
450 if( is_null( $revision ) ) {
451 wfDebug( __METHOD__
." failed to retrieve specified revision, id $oldid\n" );
454 $data = $this->pageDataFromId( $dbr, $revision->getPage() );
456 wfDebug( __METHOD__
." failed to get page data linked to revision id $oldid\n" );
459 $this->mTitle
= Title
::makeTitle( $data->page_namespace
, $data->page_title
);
460 $this->loadPageData( $data );
462 if( !$this->mDataLoaded
) {
463 $data = $this->pageDataFromTitle( $dbr, $this->mTitle
);
465 wfDebug( __METHOD__
." failed to find page data for title " . $this->mTitle
->getPrefixedText() . "\n" );
468 $this->loadPageData( $data );
470 $revision = Revision
::newFromId( $this->mLatest
);
471 if( is_null( $revision ) ) {
472 wfDebug( __METHOD__
." failed to retrieve current page, rev_id {$this->mLatest}\n" );
477 // FIXME: Horrible, horrible! This content-loading interface just plain sucks.
478 // We should instead work with the Revision object when we need it...
479 $this->mContent
= $revision->getText( Revision
::FOR_THIS_USER
); // Loads if user is allowed
481 $this->mUser
= $revision->getUser();
482 $this->mUserText
= $revision->getUserText();
483 $this->mComment
= $revision->getComment();
484 $this->mTimestamp
= wfTimestamp( TS_MW
, $revision->getTimestamp() );
486 $this->mRevIdFetched
= $revision->getId();
487 $this->mContentLoaded
= true;
488 $this->mRevision
=& $revision;
490 wfRunHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent
) ) ;
492 return $this->mContent
;
496 * Read/write accessor to select FOR UPDATE
498 * @param $x Mixed: FIXME
500 public function forUpdate( $x = NULL ) {
501 return wfSetVar( $this->mForUpdate
, $x );
505 * Get the database which should be used for reads
508 * @deprecated - just call wfGetDB( DB_MASTER ) instead
511 wfDeprecated( __METHOD__
);
512 return wfGetDB( DB_MASTER
);
516 * Get options for all SELECT statements
518 * @param $options Array: an optional options array which'll be appended to
520 * @return Array: options
522 protected function getSelectOptions( $options = '' ) {
523 if( $this->mForUpdate
) {
524 if( is_array( $options ) ) {
525 $options[] = 'FOR UPDATE';
527 $options = 'FOR UPDATE';
534 * @return int Page ID
536 public function getID() {
537 if( $this->mTitle
) {
538 return $this->mTitle
->getArticleID();
545 * @return bool Whether or not the page exists in the database
547 public function exists() {
548 return $this->getId() > 0;
552 * Check if this page is something we're going to be showing
553 * some sort of sensible content for. If we return false, page
554 * views (plain action=view) will return an HTTP 404 response,
555 * so spiders and robots can know they're following a bad link.
559 public function hasViewableContent() {
560 return $this->exists() ||
$this->mTitle
->isAlwaysKnown();
564 * @return int The view count for the page
566 public function getCount() {
567 if( -1 == $this->mCounter
) {
568 $id = $this->getID();
572 $dbr = wfGetDB( DB_SLAVE
);
573 $this->mCounter
= $dbr->selectField( 'page',
575 array( 'page_id' => $id ),
577 $this->getSelectOptions()
581 return $this->mCounter
;
585 * Determine whether a page would be suitable for being counted as an
586 * article in the site_stats table based on the title & its content
588 * @param $text String: text to analyze
591 public function isCountable( $text ) {
592 global $wgUseCommaCount;
594 $token = $wgUseCommaCount ?
',' : '[[';
595 return $this->mTitle
->isContentPage() && !$this->isRedirect($text) && in_string($token,$text);
599 * Tests if the article text represents a redirect
601 * @param $text String: FIXME
604 public function isRedirect( $text = false ) {
605 if( $text === false ) {
606 if( $this->mDataLoaded
) {
607 return $this->mIsRedirect
;
609 // Apparently loadPageData was never called
610 $this->loadContent();
611 $titleObj = Title
::newFromRedirectRecurse( $this->fetchContent() );
613 $titleObj = Title
::newFromRedirect( $text );
615 return $titleObj !== NULL;
619 * Returns true if the currently-referenced revision is the current edit
620 * to this page (and it exists).
623 public function isCurrent() {
624 # If no oldid, this is the current version.
625 if( $this->getOldID() == 0 ) {
628 return $this->exists() && isset($this->mRevision
) && $this->mRevision
->isCurrent();
632 * Loads everything except the text
633 * This isn't necessary for all uses, so it's only done if needed.
635 protected function loadLastEdit() {
636 if( -1 != $this->mUser
)
639 # New or non-existent articles have no user information
640 $id = $this->getID();
641 if( 0 == $id ) return;
643 $this->mLastRevision
= Revision
::loadFromPageId( wfGetDB( DB_MASTER
), $id );
644 if( !is_null( $this->mLastRevision
) ) {
645 $this->mUser
= $this->mLastRevision
->getUser();
646 $this->mUserText
= $this->mLastRevision
->getUserText();
647 $this->mTimestamp
= $this->mLastRevision
->getTimestamp();
648 $this->mComment
= $this->mLastRevision
->getComment();
649 $this->mMinorEdit
= $this->mLastRevision
->isMinor();
650 $this->mRevIdFetched
= $this->mLastRevision
->getId();
654 public function getTimestamp() {
655 // Check if the field has been filled by ParserCache::get()
656 if( !$this->mTimestamp
) {
657 $this->loadLastEdit();
659 return wfTimestamp(TS_MW
, $this->mTimestamp
);
662 public function getUser() {
663 $this->loadLastEdit();
667 public function getUserText() {
668 $this->loadLastEdit();
669 return $this->mUserText
;
672 public function getComment() {
673 $this->loadLastEdit();
674 return $this->mComment
;
677 public function getMinorEdit() {
678 $this->loadLastEdit();
679 return $this->mMinorEdit
;
682 /* Use this to fetch the rev ID used on page views */
683 public function getRevIdFetched() {
684 $this->loadLastEdit();
685 return $this->mRevIdFetched
;
689 * @param $limit Integer: default 0.
690 * @param $offset Integer: default 0.
692 public function getContributors($limit = 0, $offset = 0) {
693 # XXX: this is expensive; cache this info somewhere.
696 $dbr = wfGetDB( DB_SLAVE
);
697 $revTable = $dbr->tableName( 'revision' );
698 $userTable = $dbr->tableName( 'user' );
699 $user = $this->getUser();
700 $pageId = $this->getId();
702 $deletedBit = $dbr->bitAnd('rev_deleted', Revision
::DELETED_USER
); // username hidden?
704 $sql = "SELECT {$userTable}.*, MAX(rev_timestamp) as timestamp
705 FROM $revTable LEFT JOIN $userTable ON rev_user = user_id
706 WHERE rev_page = $pageId
707 AND rev_user != $user
709 GROUP BY rev_user, rev_user_text, user_real_name
710 ORDER BY timestamp DESC";
713 $sql = $dbr->limitResult($sql, $limit, $offset);
715 $sql .= ' '. $this->getSelectOptions();
717 $res = $dbr->query($sql, __METHOD__
);
719 return new UserArrayFromResult( $res );
723 * This is the default action of the index.php entry point: just view the
724 * page of the given title.
726 public function view() {
727 global $wgUser, $wgOut, $wgRequest, $wgContLang;
728 global $wgEnableParserCache, $wgStylePath, $wgParser;
729 global $wgUseTrackbacks, $wgUseFileCache;
731 wfProfileIn( __METHOD__
);
733 # Get variables from query string
734 $oldid = $this->getOldID();
735 $parserCache = ParserCache
::singleton();
737 $parserOptions = clone $this->getParserOptions();
738 # Render printable version, use printable version cache
739 if ( $wgOut->isPrintable() ) {
740 $parserOptions->setIsPrintable( true );
743 # Try client and file cache
744 if( $oldid === 0 && $this->checkTouched() ) {
747 $wgOut->setETag( $parserCache->getETag( $this, $parserOptions ) );
749 # Is is client cached?
750 if( $wgOut->checkLastModified( $this->getTouched() ) ) {
751 wfDebug( __METHOD__
.": done 304\n" );
752 wfProfileOut( __METHOD__
);
755 } else if( $wgUseFileCache && $this->tryFileCache() ) {
756 wfDebug( __METHOD__
.": done file cache\n" );
757 # tell wgOut that output is taken care of
759 $this->viewUpdates();
760 wfProfileOut( __METHOD__
);
765 $sk = $wgUser->getSkin();
767 # getOldID may want us to redirect somewhere else
768 if( $this->mRedirectUrl
) {
769 $wgOut->redirect( $this->mRedirectUrl
);
770 wfDebug( __METHOD__
.": redirecting due to oldid\n" );
771 wfProfileOut( __METHOD__
);
775 $wgOut->setArticleFlag( true );
776 # Set page title (may be overridden by DISPLAYTITLE)
777 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
779 # If we got diff in the query, we want to see a diff page instead of the article.
780 if( !is_null( $wgRequest->getVal( 'diff' ) ) ) {
781 wfDebug( __METHOD__
.": showing diff page\n" );
782 $this->showDiffPage();
783 wfProfileOut( __METHOD__
);
787 # Should the parser cache be used?
788 $useParserCache = $this->useParserCache( $oldid );
789 wfDebug( 'Article::view using parser cache: ' . ($useParserCache ?
'yes' : 'no' ) . "\n" );
790 if( $wgUser->getOption( 'stubthreshold' ) ) {
791 wfIncrStats( 'pcache_miss_stub' );
794 # For the main page, overwrite the <title> element with the con-
795 # tents of 'pagetitle-view-mainpage' instead of the default (if
797 if( $this->mTitle
->equals( Title
::newMainPage() )
798 && ($m=wfMsgForContent( 'pagetitle-view-mainpage' )) !== '' )
800 $wgOut->setHTMLTitle( $m );
803 $wasRedirected = $this->showRedirectedFromHeader();
804 $this->showNamespaceHeader();
806 # Iterate through the possible ways of constructing the output text.
807 # Keep going until $outputDone is set, or we run out of things to do.
810 while( !$outputDone && ++
$pass ){
813 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
817 # Try the parser cache
818 if( $useParserCache ) {
819 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
820 if ( $this->mParserOutput
!== false ) {
821 wfDebug( __METHOD__
.": showing parser cache contents\n" );
822 $wgOut->addParserOutput( $this->mParserOutput
);
823 # Ensure that UI elements requiring revision ID have
824 # the correct version information.
825 $wgOut->setRevisionId( $this->mLatest
);
832 $text = $this->getContent();
833 if( $text === false ||
$this->getID() == 0 ) {
834 wfDebug( __METHOD__
.": showing missing article\n" );
835 $this->showMissingArticle();
836 wfProfileOut( __METHOD__
);
840 # Another whitelist check in case oldid is altering the title
841 if( !$this->mTitle
->userCanRead() ) {
842 wfDebug( __METHOD__
.": denied on secondary read check\n" );
843 $wgOut->loginToUse();
846 wfProfileOut( __METHOD__
);
850 # Are we looking at an old revision
851 if( $oldid && !is_null( $this->mRevision
) ) {
852 $this->setOldSubtitle( $oldid );
853 if ( !$this->showDeletedRevisionHeader() ) {
854 wfDebug( __METHOD__
.": cannot view deleted revision\n" );
855 wfProfileOut( __METHOD__
);
858 # If this "old" version is the current, then try the parser cache...
859 if ( $oldid === $this->getLatest() && $this->useParserCache( false ) ) {
860 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
861 if ( $this->mParserOutput
) {
862 wfDebug( __METHOD__
.": showing parser cache for current rev permalink\n" );
863 $wgOut->addParserOutput( $this->mParserOutput
);
864 $wgOut->setRevisionId( $this->mLatest
);
865 $this->showViewFooter();
866 $this->viewUpdates();
867 wfProfileOut( __METHOD__
);
873 # Ensure that UI elements requiring revision ID have
874 # the correct version information.
875 $wgOut->setRevisionId( $this->getRevIdFetched() );
877 # Pages containing custom CSS or JavaScript get special treatment
878 if( $this->mTitle
->isCssOrJsPage() ||
$this->mTitle
->isCssJsSubpage() ) {
879 wfDebug( __METHOD__
.": showing CSS/JS source\n" );
880 $this->showCssOrJsPage();
882 } else if( $rt = Title
::newFromRedirectArray( $text ) ) {
883 wfDebug( __METHOD__
.": showing redirect=no page\n" );
884 # Viewing a redirect page (e.g. with parameter redirect=no)
885 # Don't append the subtitle if this was an old revision
886 $wgOut->addHTML( $this->viewRedirect( $rt, !$wasRedirected && $this->isCurrent() ) );
887 # Parse just to get categories, displaytitle, etc.
888 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
, $parserOptions );
889 $wgOut->addParserOutputNoText( $this->mParserOutput
);
895 # Run the parse, protected by a pool counter
896 wfDebug( __METHOD__
.": doing uncached parse\n" );
897 $key = $parserCache->getKey( $this, $parserOptions );
898 $poolCounter = PoolCounter
::factory( 'Article::view', $key );
899 $dirtyCallback = $useParserCache ?
array( $this, 'tryDirtyCache' ) : false;
900 $status = $poolCounter->executeProtected( array( $this, 'doViewParse' ), $dirtyCallback );
902 if ( !$status->isOK() ) {
903 # Connection or timeout error
904 $this->showPoolError( $status );
905 wfProfileOut( __METHOD__
);
912 # Should be unreachable, but just in case...
918 # Now that we've filled $this->mParserOutput, we know whether
919 # there are any __NOINDEX__ tags on the page
920 $policy = $this->getRobotPolicy( 'view' );
921 $wgOut->setIndexPolicy( $policy['index'] );
922 $wgOut->setFollowPolicy( $policy['follow'] );
924 $this->showViewFooter();
925 $this->viewUpdates();
926 wfProfileOut( __METHOD__
);
930 * Show a diff page according to current request variables. For use within
931 * Article::view() only, other callers should use the DifferenceEngine class.
933 public function showDiffPage() {
934 global $wgOut, $wgRequest, $wgUser;
936 $diff = $wgRequest->getVal( 'diff' );
937 $rcid = $wgRequest->getVal( 'rcid' );
938 $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
939 $purge = $wgRequest->getVal( 'action' ) == 'purge';
940 $htmldiff = $wgRequest->getBool( 'htmldiff' );
941 $unhide = $wgRequest->getInt('unhide') == 1;
942 $oldid = $this->getOldID();
944 $de = new DifferenceEngine( $this->mTitle
, $oldid, $diff, $rcid, $purge, $htmldiff, $unhide );
945 // DifferenceEngine directly fetched the revision:
946 $this->mRevIdFetched
= $de->mNewid
;
947 $de->showDiffPage( $diffOnly );
949 // Needed to get the page's current revision
950 $this->loadPageData();
951 if( $diff == 0 ||
$diff == $this->mLatest
) {
952 # Run view updates for current revision only
953 $this->viewUpdates();
958 * Show a page view for a page formatted as CSS or JavaScript. To be called by
959 * Article::view() only.
961 * This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these
964 public function showCssOrJsPage() {
966 $wgOut->addHTML( wfMsgExt( 'clearyourcache', 'parse' ) );
967 // Give hooks a chance to customise the output
968 if( wfRunHooks( 'ShowRawCssJs', array( $this->mContent
, $this->mTitle
, $wgOut ) ) ) {
969 // Wrap the whole lot in a <pre> and don't parse
971 preg_match( '!\.(css|js)$!u', $this->mTitle
->getText(), $m );
972 $wgOut->addHTML( "<pre class=\"mw-code mw-{$m[1]}\" dir=\"ltr\">\n" );
973 $wgOut->addHTML( htmlspecialchars( $this->mContent
) );
974 $wgOut->addHTML( "\n</pre>\n" );
979 * Get the robot policy to be used for the current action=view request.
980 * @return String the policy that should be set
981 * @deprecated use getRobotPolicy() instead, which returns an associative
984 public function getRobotPolicyForView() {
985 wfDeprecated( __FUNC__
);
986 $policy = $this->getRobotPolicy( 'view' );
987 return $policy['index'] . ',' . $policy['follow'];
991 * Get the robot policy to be used for the current view
992 * @param $action String the action= GET parameter
993 * @return Array the policy that should be set
994 * TODO: actions other than 'view'
996 public function getRobotPolicy( $action ){
998 global $wgOut, $wgArticleRobotPolicies, $wgNamespaceRobotPolicies;
999 global $wgDefaultRobotPolicy, $wgRequest;
1001 $ns = $this->mTitle
->getNamespace();
1002 if( $ns == NS_USER ||
$ns == NS_USER_TALK
) {
1003 # Don't index user and user talk pages for blocked users (bug 11443)
1004 if( !$this->mTitle
->isSubpage() ) {
1005 $block = new Block();
1006 if( $block->load( $this->mTitle
->getText() ) ) {
1007 return array( 'index' => 'noindex',
1008 'follow' => 'nofollow' );
1013 if( $this->getID() === 0 ||
$this->getOldID() ) {
1014 # Non-articles (special pages etc), and old revisions
1015 return array( 'index' => 'noindex',
1016 'follow' => 'nofollow' );
1017 } elseif( $wgOut->isPrintable() ) {
1018 # Discourage indexing of printable versions, but encourage following
1019 return array( 'index' => 'noindex',
1020 'follow' => 'follow' );
1021 } elseif( $wgRequest->getInt('curid') ) {
1022 # For ?curid=x urls, disallow indexing
1023 return array( 'index' => 'noindex',
1024 'follow' => 'follow' );
1027 # Otherwise, construct the policy based on the various config variables.
1028 $policy = self
::formatRobotPolicy( $wgDefaultRobotPolicy );
1030 if( isset( $wgNamespaceRobotPolicies[$ns] ) ){
1031 # Honour customised robot policies for this namespace
1032 $policy = array_merge( $policy,
1033 self
::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] ) );
1035 if( $this->mTitle
->canUseNoindex() && is_object( $this->mParserOutput
) && $this->mParserOutput
->getIndexPolicy() ){
1036 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
1037 # a final sanity check that we have really got the parser output.
1038 $policy = array_merge( $policy,
1039 array( 'index' => $this->mParserOutput
->getIndexPolicy() ) );
1042 if( isset( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] ) ){
1043 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
1044 $policy = array_merge( $policy,
1045 self
::formatRobotPolicy( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] ) );
1053 * Converts a String robot policy into an associative array, to allow
1054 * merging of several policies using array_merge().
1055 * @param $policy Mixed, returns empty array on null/false/'', transparent
1056 * to already-converted arrays, converts String.
1057 * @return associative Array: 'index' => <indexpolicy>, 'follow' => <followpolicy>
1059 public static function formatRobotPolicy( $policy ){
1060 if( is_array( $policy ) ){
1062 } elseif( !$policy ){
1066 $policy = explode( ',', $policy );
1067 $policy = array_map( 'trim', $policy );
1070 foreach( $policy as $var ){
1071 if( in_array( $var, array('index','noindex') ) ){
1072 $arr['index'] = $var;
1073 } elseif( in_array( $var, array('follow','nofollow') ) ){
1074 $arr['follow'] = $var;
1081 * If this request is a redirect view, send "redirected from" subtitle to
1082 * $wgOut. Returns true if the header was needed, false if this is not a
1083 * redirect view. Handles both local and remote redirects.
1085 public function showRedirectedFromHeader() {
1086 global $wgOut, $wgUser, $wgRequest, $wgRedirectSources;
1088 $rdfrom = $wgRequest->getVal( 'rdfrom' );
1089 $sk = $wgUser->getSkin();
1090 if( isset( $this->mRedirectedFrom
) ) {
1091 // This is an internally redirected page view.
1092 // We'll need a backlink to the source page for navigation.
1093 if( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
1095 $this->mRedirectedFrom
,
1098 array( 'redirect' => 'no' ),
1099 array( 'known', 'noclasses' )
1101 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1102 $wgOut->setSubtitle( $s );
1104 // Set the fragment if one was specified in the redirect
1105 if( strval( $this->mTitle
->getFragment() ) != '' ) {
1106 $fragment = Xml
::escapeJsString( $this->mTitle
->getFragmentForURL() );
1107 $wgOut->addInlineScript( "redirectToFragment(\"$fragment\");" );
1110 // Add a <link rel="canonical"> tag
1111 $wgOut->addLink( array( 'rel' => 'canonical',
1112 'href' => $this->mTitle
->getLocalURL() )
1116 } elseif( $rdfrom ) {
1117 // This is an externally redirected view, from some other wiki.
1118 // If it was reported from a trusted site, supply a backlink.
1119 if( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
1120 $redir = $sk->makeExternalLink( $rdfrom, $rdfrom );
1121 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1122 $wgOut->setSubtitle( $s );
1130 * Show a header specific to the namespace currently being viewed, like
1131 * [[MediaWiki:Talkpagetext]]. For Article::view().
1133 public function showNamespaceHeader() {
1135 if( $this->mTitle
->isTalkPage() ) {
1136 $msg = wfMsgNoTrans( 'talkpageheader' );
1137 if ( $msg !== '-' && !wfEmptyMsg( 'talkpageheader', $msg ) ) {
1138 $wgOut->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1</div>", array( 'talkpageheader' ) );
1144 * Show the footer section of an ordinary page view
1146 public function showViewFooter() {
1147 global $wgOut, $wgUseTrackbacks, $wgRequest;
1148 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1149 if( $this->mTitle
->getNamespace() == NS_USER_TALK
&& IP
::isValid( $this->mTitle
->getText() ) ) {
1150 $wgOut->addWikiMsg('anontalkpagetext');
1153 # If we have been passed an &rcid= parameter, we want to give the user a
1154 # chance to mark this new article as patrolled.
1155 $this->showPatrolFooter();
1158 if( $wgUseTrackbacks ) {
1159 $this->addTrackbacks();
1164 * If patrol is possible, output a patrol UI box. This is called from the
1165 * footer section of ordinary page views. If patrol is not possible or not
1166 * desired, does nothing.
1168 public function showPatrolFooter() {
1169 global $wgOut, $wgRequest, $wgUser;
1170 $rcid = $wgRequest->getVal( 'rcid' );
1172 if( !$rcid ||
!$this->mTitle
->exists() ||
!$this->mTitle
->quickUserCan( 'patrol' ) ) {
1176 $sk = $wgUser->getSkin();
1179 "<div class='patrollink'>" .
1181 'markaspatrolledlink',
1184 wfMsgHtml( 'markaspatrolledtext' ),
1187 'action' => 'markpatrolled',
1190 array( 'known', 'noclasses' )
1198 * Show the error text for a missing article. For articles in the MediaWiki
1199 * namespace, show the default message text. To be called from Article::view().
1201 public function showMissingArticle() {
1202 global $wgOut, $wgRequest, $wgUser;
1204 # Show info in user (talk) namespace. Does the user exist and if not, has he been renamed.
1205 if ( $this->mTitle
->getNamespace() == NS_USER ||
$this->mTitle
->getNamespace() == NS_USER_TALK
) {
1206 $id = User
::idFromName( $this->mTitle
->getBaseText() );
1207 $ip = User
::isIP( $this->mTitle
->getBaseText() );
1208 if ( $id == 0 && !$ip ) { # User does not exist
1209 $wgOut->wrapWikiMsg( '<div class="mw-userpage-userdoesnotexist error">$1</div>',
1210 array( 'userpage-userdoesnotexist-view', $this->mTitle
->getBaseText() ) );
1212 # Show rename log because user does not exist.
1213 $parent = $this->mTitle
->getNsText() . ":" . $this->mTitle
->getBaseText();
1214 $wgOut->showLogs( $parent, '', array( 'renameuser' ), 'renamed-notice' );
1218 # Show delete and move logs
1219 $wgOut->showLogs( $this->mTitle
->getPrefixedText(), '', array( 'delete', 'move' ), 'moveddeleted-notice' );
1221 # Show error message
1222 $oldid = $this->getOldID();
1224 $text = wfMsgNoTrans( 'missing-article',
1225 $this->mTitle
->getPrefixedText(),
1226 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
1227 } elseif ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
) {
1228 // Use the default message text
1229 $text = $this->getContent();
1231 $createErrors = $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser );
1232 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
1233 $errors = array_merge( $createErrors, $editErrors );
1235 if ( !count($errors) )
1236 $text = wfMsgNoTrans( 'noarticletext' );
1238 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
1240 $text = "<div class='noarticletext'>\n$text\n</div>";
1241 if( !$this->hasViewableContent() ) {
1242 // If there's no backing content, send a 404 Not Found
1243 // for better machine handling of broken links.
1244 $wgRequest->response()->header( "HTTP/1.x 404 Not Found" );
1246 $wgOut->addWikiText( $text );
1250 * If the revision requested for view is deleted, check permissions.
1251 * Send either an error message or a warning header to $wgOut.
1252 * Returns true if the view is allowed, false if not.
1254 public function showDeletedRevisionHeader() {
1255 global $wgOut, $wgRequest;
1256 if( !$this->mRevision
->isDeleted( Revision
::DELETED_TEXT
) ) {
1260 // If the user is not allowed to see it...
1261 if( !$this->mRevision
->userCan(Revision
::DELETED_TEXT
) ) {
1262 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1</div>\n",
1263 'rev-deleted-text-permission' );
1265 // If the user needs to confirm that they want to see it...
1266 } else if( $wgRequest->getInt('unhide') != 1 ) {
1267 # Give explanation and add a link to view the revision...
1268 $oldid = intval( $this->getOldID() );
1269 $link = $this->mTitle
->getFullUrl( "oldid={$oldid}&unhide=1" );
1270 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1271 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1272 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1</div>\n",
1273 array($msg,$link) );
1275 // We are allowed to see...
1277 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1278 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1279 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1</div>\n", $msg );
1285 * Should the parser cache be used?
1287 public function useParserCache( $oldid ) {
1288 global $wgUser, $wgEnableParserCache;
1290 return $wgEnableParserCache
1291 && intval( $wgUser->getOption( 'stubthreshold' ) ) == 0
1294 && !$this->mTitle
->isCssOrJsPage()
1295 && !$this->mTitle
->isCssJsSubpage();
1299 * Execute the uncached parse for action=view
1301 public function doViewParse() {
1303 $oldid = $this->getOldID();
1304 $useParserCache = $this->useParserCache( $oldid );
1305 $parserOptions = clone $this->getParserOptions();
1306 # Render printable version, use printable version cache
1307 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
1308 # Don't show section-edit links on old revisions... this way lies madness.
1309 $parserOptions->setEditSection( $this->isCurrent() );
1310 $useParserCache = $this->useParserCache( $oldid );
1311 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1315 * Try to fetch an expired entry from the parser cache. If it is present,
1316 * output it and return true. If it is not present, output nothing and
1317 * return false. This is used as a callback function for
1318 * PoolCounter::executeProtected().
1320 public function tryDirtyCache() {
1322 $parserCache = ParserCache
::singleton();
1323 $options = $this->getParserOptions();
1324 $options->setIsPrintable( $wgOut->isPrintable() );
1325 $output = $parserCache->getDirty( $this, $options );
1327 wfDebug( __METHOD__
.": sending dirty output\n" );
1328 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1329 $wgOut->setSquidMaxage( 0 );
1330 $this->mParserOutput
= $output;
1331 $wgOut->addParserOutput( $output );
1332 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1335 wfDebugLog( 'dirty', "dirty missing\n" );
1336 wfDebug( __METHOD__
.": no dirty cache\n" );
1342 * Show an error page for an error from the pool counter.
1343 * @param $status Status
1345 public function showPoolError( $status ) {
1347 $wgOut->clearHTML(); // for release() errors
1348 $wgOut->enableClientCache( false );
1349 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1350 $wgOut->addWikiText(
1351 '<div class="errorbox">' .
1352 $status->getWikiText( false, 'view-pool-error' ) .
1359 * @param $target Title object or Array of destination(s) to redirect
1360 * @param $appendSubtitle Boolean [optional]
1361 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1363 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1364 global $wgParser, $wgOut, $wgContLang, $wgStylePath, $wgUser;
1366 if( !is_array( $target ) ) {
1367 $target = array( $target );
1369 $imageDir = $wgContLang->getDir();
1370 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1371 $imageUrl2 = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1372 $alt2 = $wgContLang->isRTL() ?
'←' : '→'; // should -> and <- be used instead of entities?
1374 if( $appendSubtitle ) {
1375 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1377 $sk = $wgUser->getSkin();
1378 // the loop prepends the arrow image before the link, so the first case needs to be outside
1379 $title = array_shift( $target );
1383 htmlspecialchars( $title->getFullText() ),
1386 array( 'known', 'noclasses' )
1389 $link = $sk->link( $title, htmlspecialchars( $title->getFullText() ) );
1391 // automatically append redirect=no to each link, since most of them are redirect pages themselves
1392 foreach( $target as $rt ) {
1394 $link .= '<img src="'.$imageUrl2.'" alt="'.$alt2.' " />'
1397 htmlspecialchars( $rt->getFullText() ),
1400 array( 'known', 'noclasses' )
1403 $link .= '<img src="'.$imageUrl2.'" alt="'.$alt2.' " />'
1404 . $sk->link( $rt, htmlspecialchars( $rt->getFullText() ) );
1407 return '<img src="'.$imageUrl.'" alt="#REDIRECT " />' .
1408 '<span class="redirectText">'.$link.'</span>';
1412 public function addTrackbacks() {
1413 global $wgOut, $wgUser;
1414 $dbr = wfGetDB( DB_SLAVE
);
1415 $tbs = $dbr->select( 'trackbacks',
1416 array('tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name'),
1417 array('tb_page' => $this->getID() )
1419 if( !$dbr->numRows($tbs) ) return;
1422 while( $o = $dbr->fetchObject($tbs) ) {
1424 if( $wgUser->isAllowed( 'trackback' ) ) {
1425 $delurl = $this->mTitle
->getFullURL("action=deletetrackback&tbid=" .
1426 $o->tb_id
. "&token=" . urlencode( $wgUser->editToken() ) );
1427 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1430 $tbtext .= wfMsg(strlen($o->tb_ex
) ?
'trackbackexcerpt' : 'trackback',
1437 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>$1</div>\n", array( 'trackbackbox', $tbtext ) );
1438 $this->mTitle
->invalidateCache();
1441 public function deletetrackback() {
1442 global $wgUser, $wgRequest, $wgOut;
1443 if( !$wgUser->matchEditToken($wgRequest->getVal('token')) ) {
1444 $wgOut->addWikiMsg( 'sessionfailure' );
1448 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
1449 if( count($permission_errors) ) {
1450 $wgOut->showPermissionsErrorPage( $permission_errors );
1454 $db = wfGetDB( DB_MASTER
);
1455 $db->delete( 'trackbacks', array('tb_id' => $wgRequest->getInt('tbid')) );
1457 $wgOut->addWikiMsg( 'trackbackdeleteok' );
1458 $this->mTitle
->invalidateCache();
1461 public function render() {
1463 $wgOut->setArticleBodyOnly(true);
1468 * Handle action=purge
1470 public function purge() {
1471 global $wgUser, $wgRequest, $wgOut;
1472 if( $wgUser->isAllowed( 'purge' ) ||
$wgRequest->wasPosted() ) {
1473 if( wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1478 $action = htmlspecialchars( $wgRequest->getRequestURL() );
1479 $button = wfMsgExt( 'confirm_purge_button', array('escapenoentities') );
1480 $form = "<form method=\"post\" action=\"$action\">\n" .
1481 "<input type=\"submit\" name=\"submit\" value=\"$button\" />\n" .
1483 $top = wfMsgExt( 'confirm-purge-top', array('parse') );
1484 $bottom = wfMsgExt( 'confirm-purge-bottom', array('parse') );
1485 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
1486 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1487 $wgOut->addHTML( $top . $form . $bottom );
1492 * Perform the actions of a page purging
1494 public function doPurge() {
1496 // Invalidate the cache
1497 $this->mTitle
->invalidateCache();
1500 // Commit the transaction before the purge is sent
1501 $dbw = wfGetDB( DB_MASTER
);
1502 $dbw->immediateCommit();
1505 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
1506 $update->doUpdate();
1508 if( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1509 global $wgMessageCache;
1510 if( $this->getID() == 0 ) {
1513 $text = $this->getRawText();
1515 $wgMessageCache->replace( $this->mTitle
->getDBkey(), $text );
1520 * Insert a new empty page record for this article.
1521 * This *must* be followed up by creating a revision
1522 * and running $this->updateToLatest( $rev_id );
1523 * or else the record will be left in a funky state.
1524 * Best if all done inside a transaction.
1526 * @param $dbw Database
1527 * @return int The newly created page_id key, or false if the title already existed
1530 public function insertOn( $dbw ) {
1531 wfProfileIn( __METHOD__
);
1533 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1534 $dbw->insert( 'page', array(
1535 'page_id' => $page_id,
1536 'page_namespace' => $this->mTitle
->getNamespace(),
1537 'page_title' => $this->mTitle
->getDBkey(),
1538 'page_counter' => 0,
1539 'page_restrictions' => '',
1540 'page_is_redirect' => 0, # Will set this shortly...
1542 'page_random' => wfRandom(),
1543 'page_touched' => $dbw->timestamp(),
1544 'page_latest' => 0, # Fill this in shortly...
1545 'page_len' => 0, # Fill this in shortly...
1546 ), __METHOD__
, 'IGNORE' );
1548 $affected = $dbw->affectedRows();
1550 $newid = $dbw->insertId();
1551 $this->mTitle
->resetArticleId( $newid );
1553 wfProfileOut( __METHOD__
);
1554 return $affected ?
$newid : false;
1558 * Update the page record to point to a newly saved revision.
1560 * @param $dbw Database object
1561 * @param $revision Revision: For ID number, and text used to set
1562 length and redirect status fields
1563 * @param $lastRevision Integer: if given, will not overwrite the page field
1564 * when different from the currently set value.
1565 * Giving 0 indicates the new page flag should be set
1567 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1568 * removing rows in redirect table.
1569 * @return bool true on success, false on failure
1572 public function updateRevisionOn( &$dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null ) {
1573 wfProfileIn( __METHOD__
);
1575 $text = $revision->getText();
1576 $rt = Title
::newFromRedirect( $text );
1578 $conditions = array( 'page_id' => $this->getId() );
1579 if( !is_null( $lastRevision ) ) {
1580 # An extra check against threads stepping on each other
1581 $conditions['page_latest'] = $lastRevision;
1584 $dbw->update( 'page',
1586 'page_latest' => $revision->getId(),
1587 'page_touched' => $dbw->timestamp(),
1588 'page_is_new' => ($lastRevision === 0) ?
1 : 0,
1589 'page_is_redirect' => $rt !== NULL ?
1 : 0,
1590 'page_len' => strlen( $text ),
1595 $result = $dbw->affectedRows() != 0;
1597 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1600 wfProfileOut( __METHOD__
);
1605 * Add row to the redirect table if this is a redirect, remove otherwise.
1607 * @param $dbw Database
1608 * @param $redirectTitle a title object pointing to the redirect target,
1609 * or NULL if this is not a redirect
1610 * @param $lastRevIsRedirect If given, will optimize adding and
1611 * removing rows in redirect table.
1612 * @return bool true on success, false on failure
1615 public function updateRedirectOn( &$dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1616 // Always update redirects (target link might have changed)
1617 // Update/Insert if we don't know if the last revision was a redirect or not
1618 // Delete if changing from redirect to non-redirect
1619 $isRedirect = !is_null($redirectTitle);
1620 if($isRedirect ||
is_null($lastRevIsRedirect) ||
$lastRevIsRedirect !== $isRedirect) {
1621 wfProfileIn( __METHOD__
);
1623 // This title is a redirect, Add/Update row in the redirect table
1624 $set = array( /* SET */
1625 'rd_namespace' => $redirectTitle->getNamespace(),
1626 'rd_title' => $redirectTitle->getDBkey(),
1627 'rd_from' => $this->getId(),
1629 $dbw->replace( 'redirect', array( 'rd_from' ), $set, __METHOD__
);
1631 // This is not a redirect, remove row from redirect table
1632 $where = array( 'rd_from' => $this->getId() );
1633 $dbw->delete( 'redirect', $where, __METHOD__
);
1635 if( $this->getTitle()->getNamespace() == NS_FILE
) {
1636 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1638 wfProfileOut( __METHOD__
);
1639 return ( $dbw->affectedRows() != 0 );
1645 * If the given revision is newer than the currently set page_latest,
1646 * update the page record. Otherwise, do nothing.
1648 * @param $dbw Database object
1649 * @param $revision Revision object
1651 public function updateIfNewerOn( &$dbw, $revision ) {
1652 wfProfileIn( __METHOD__
);
1653 $row = $dbw->selectRow(
1654 array( 'revision', 'page' ),
1655 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1657 'page_id' => $this->getId(),
1658 'page_latest=rev_id' ),
1661 if( wfTimestamp(TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1662 wfProfileOut( __METHOD__
);
1665 $prev = $row->rev_id
;
1666 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1668 # No or missing previous revision; mark the page as new
1670 $lastRevIsRedirect = null;
1672 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1673 wfProfileOut( __METHOD__
);
1678 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
1679 * @return string Complete article text, or null if error
1681 public function replaceSection( $section, $text, $summary = '', $edittime = NULL ) {
1682 wfProfileIn( __METHOD__
);
1683 if( strval( $section ) == '' ) {
1684 // Whole-page edit; let the whole text through
1686 if( is_null($edittime) ) {
1687 $rev = Revision
::newFromTitle( $this->mTitle
);
1689 $dbw = wfGetDB( DB_MASTER
);
1690 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1693 wfDebug( "Article::replaceSection asked for bogus section (page: " .
1694 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1697 $oldtext = $rev->getText();
1699 if( $section == 'new' ) {
1700 # Inserting a new section
1701 $subject = $summary ?
wfMsgForContent('newsectionheaderdefaultlevel',$summary) . "\n\n" : '';
1702 $text = strlen( trim( $oldtext ) ) > 0
1703 ?
"{$oldtext}\n\n{$subject}{$text}"
1704 : "{$subject}{$text}";
1706 # Replacing an existing section; roll out the big guns
1708 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1711 wfProfileOut( __METHOD__
);
1716 * This function is not deprecated until somebody fixes the core not to use
1717 * it. Nevertheless, use Article::doEdit() instead.
1719 function insertNewArticle( $text, $summary, $isminor, $watchthis, $suppressRC=false, $comment=false, $bot=false ) {
1720 $flags = EDIT_NEW | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1721 ( $isminor ? EDIT_MINOR
: 0 ) |
1722 ( $suppressRC ? EDIT_SUPPRESS_RC
: 0 ) |
1723 ( $bot ? EDIT_FORCE_BOT
: 0 );
1725 # If this is a comment, add the summary as headline
1726 if( $comment && $summary != "" ) {
1727 $text = wfMsgForContent('newsectionheaderdefaultlevel',$summary) . "\n\n".$text;
1730 $this->doEdit( $text, $summary, $flags );
1732 $dbw = wfGetDB( DB_MASTER
);
1734 if(!$this->mTitle
->userIsWatching()) {
1740 if( $this->mTitle
->userIsWatching() ) {
1746 $this->doRedirect( $this->isRedirect( $text ) );
1750 * @deprecated use Article::doEdit()
1752 function updateArticle( $text, $summary, $minor, $watchthis, $forceBot = false, $sectionanchor = '' ) {
1753 $flags = EDIT_UPDATE | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1754 ( $minor ? EDIT_MINOR
: 0 ) |
1755 ( $forceBot ? EDIT_FORCE_BOT
: 0 );
1757 $status = $this->doEdit( $text, $summary, $flags );
1758 if( !$status->isOK() ) {
1762 $dbw = wfGetDB( DB_MASTER
);
1764 if(!$this->mTitle
->userIsWatching()) {
1770 if( $this->mTitle
->userIsWatching() ) {
1777 $extraQuery = ''; // Give extensions a chance to modify URL query on update
1778 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this, &$sectionanchor, &$extraQuery ) );
1780 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor, $extraQuery );
1787 * Change an existing article or create a new article. Updates RC and all necessary caches,
1788 * optionally via the deferred update array.
1790 * $wgUser must be set before calling this function.
1792 * @param $text String: new text
1793 * @param $summary String: edit summary
1794 * @param $flags Integer bitfield:
1796 * Article is known or assumed to be non-existent, create a new one
1798 * Article is known or assumed to be pre-existing, update it
1800 * Mark this edit minor, if the user is allowed to do so
1802 * Do not log the change in recentchanges
1804 * Mark the edit a "bot" edit regardless of user rights
1805 * EDIT_DEFER_UPDATES
1806 * Defer some of the updates until the end of index.php
1808 * Fill in blank summaries with generated text where possible
1810 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
1811 * If EDIT_UPDATE is specified and the article doesn't exist, the function will an
1812 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
1813 * edit-already-exists error will be returned. These two conditions are also possible with
1814 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1816 * @param $baseRevId the revision ID this edit was based off, if any
1817 * @param $user Optional user object, $wgUser will be used if not passed
1819 * @return Status object. Possible errors:
1820 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
1821 * edit-gone-missing: In update mode, but the article didn't exist
1822 * edit-conflict: In update mode, the article changed unexpectedly
1823 * edit-no-change: Warning that the text was the same as before
1824 * edit-already-exists: In creation mode, but the article already exists
1826 * Extensions may define additional errors.
1828 * $return->value will contain an associative array with members as follows:
1829 * new: Boolean indicating if the function attempted to create a new article
1830 * revision: The revision object for the inserted revision, or null
1832 * Compatibility note: this function previously returned a boolean value indicating success/failure
1834 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1835 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
1837 # Low-level sanity check
1838 if( $this->mTitle
->getText() == '' ) {
1839 throw new MWException( 'Something is trying to edit an article with an empty title' );
1842 wfProfileIn( __METHOD__
);
1844 $user = is_null($user) ?
$wgUser : $user;
1845 $status = Status
::newGood( array() );
1847 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
1848 $this->loadPageData();
1850 if( !($flags & EDIT_NEW
) && !($flags & EDIT_UPDATE
) ) {
1851 $aid = $this->mTitle
->getArticleID();
1853 $flags |
= EDIT_UPDATE
;
1859 if( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
1860 $flags & EDIT_MINOR
, null, null, &$flags, &$status ) ) )
1862 wfDebug( __METHOD__
. ": ArticleSave hook aborted save!\n" );
1863 wfProfileOut( __METHOD__
);
1864 if( $status->isOK() ) {
1865 $status->fatal( 'edit-hook-aborted');
1870 # Silently ignore EDIT_MINOR if not allowed
1871 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed('minoredit');
1872 $bot = $flags & EDIT_FORCE_BOT
;
1874 $oldtext = $this->getRawText(); // current revision
1875 $oldsize = strlen( $oldtext );
1877 # Provide autosummaries if one is not provided and autosummaries are enabled.
1878 if( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
1879 $summary = $this->getAutosummary( $oldtext, $text, $flags );
1882 $editInfo = $this->prepareTextForEdit( $text );
1883 $text = $editInfo->pst
;
1884 $newsize = strlen( $text );
1886 $dbw = wfGetDB( DB_MASTER
);
1887 $now = wfTimestampNow();
1888 $this->mTimestamp
=$now;
1890 if( $flags & EDIT_UPDATE
) {
1891 # Update article, but only if changed.
1892 $status->value
['new'] = false;
1893 # Make sure the revision is either completely inserted or not inserted at all
1894 if( !$wgDBtransactions ) {
1895 $userAbort = ignore_user_abort( true );
1900 $changed = ( strcmp( $text, $oldtext ) != 0 );
1903 $this->mGoodAdjustment
= (int)$this->isCountable( $text )
1904 - (int)$this->isCountable( $oldtext );
1905 $this->mTotalAdjustment
= 0;
1907 if( !$this->mLatest
) {
1908 # Article gone missing
1909 wfDebug( __METHOD__
.": EDIT_UPDATE specified but article doesn't exist\n" );
1910 $status->fatal( 'edit-gone-missing' );
1911 wfProfileOut( __METHOD__
);
1915 $revision = new Revision( array(
1916 'page' => $this->getId(),
1917 'comment' => $summary,
1918 'minor_edit' => $isminor,
1920 'parent_id' => $this->mLatest
,
1921 'user' => $user->getId(),
1922 'user_text' => $user->getName(),
1926 $revisionId = $revision->insertOn( $dbw );
1930 # Note that we use $this->mLatest instead of fetching a value from the master DB
1931 # during the course of this function. This makes sure that EditPage can detect
1932 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
1933 # before this function is called. A previous function used a separate query, this
1934 # creates a window where concurrent edits can cause an ignored edit conflict.
1935 $ok = $this->updateRevisionOn( $dbw, $revision, $this->mLatest
);
1938 /* Belated edit conflict! Run away!! */
1939 $status->fatal( 'edit-conflict' );
1940 # Delete the invalid revision if the DB is not transactional
1941 if( !$wgDBtransactions ) {
1942 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__
);
1947 global $wgUseRCPatrol;
1948 wfRunHooks( 'NewRevisionFromEditComplete', array($this, $revision, $baseRevId, $user) );
1949 # Update recentchanges
1950 if( !( $flags & EDIT_SUPPRESS_RC
) ) {
1951 # Mark as patrolled if the user can do so
1952 $patrolled = $wgUseRCPatrol && $this->mTitle
->userCan('autopatrol');
1953 # Add RC row to the DB
1954 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
1955 $this->mLatest
, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
1956 $revisionId, $patrolled
1958 # Log auto-patrolled edits
1960 PatrolLog
::record( $rc, true );
1963 $user->incEditCount();
1967 $status->warning( 'edit-no-change' );
1969 // Keep the same revision ID, but do some updates on it
1970 $revisionId = $this->getRevIdFetched();
1971 // Update page_touched, this is usually implicit in the page update
1972 // Other cache updates are done in onArticleEdit()
1973 $this->mTitle
->invalidateCache();
1976 if( !$wgDBtransactions ) {
1977 ignore_user_abort( $userAbort );
1979 // Now that ignore_user_abort is restored, we can respond to fatal errors
1980 if( !$status->isOK() ) {
1981 wfProfileOut( __METHOD__
);
1985 # Invalidate cache of this article and all pages using this article
1986 # as a template. Partly deferred.
1987 Article
::onArticleEdit( $this->mTitle
);
1988 # Update links tables, site stats, etc.
1989 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, $changed );
1991 # Create new article
1992 $status->value
['new'] = true;
1994 # Set statistics members
1995 # We work out if it's countable after PST to avoid counter drift
1996 # when articles are created with {{subst:}}
1997 $this->mGoodAdjustment
= (int)$this->isCountable( $text );
1998 $this->mTotalAdjustment
= 1;
2002 # Add the page record; stake our claim on this title!
2003 # This will return false if the article already exists
2004 $newid = $this->insertOn( $dbw );
2006 if( $newid === false ) {
2008 $status->fatal( 'edit-already-exists' );
2009 wfProfileOut( __METHOD__
);
2013 # Save the revision text...
2014 $revision = new Revision( array(
2016 'comment' => $summary,
2017 'minor_edit' => $isminor,
2019 'user' => $user->getId(),
2020 'user_text' => $user->getName(),
2022 $revisionId = $revision->insertOn( $dbw );
2024 $this->mTitle
->resetArticleID( $newid );
2026 # Update the page record with revision data
2027 $this->updateRevisionOn( $dbw, $revision, 0 );
2029 wfRunHooks( 'NewRevisionFromEditComplete', array($this, $revision, false, $user) );
2030 # Update recentchanges
2031 if( !( $flags & EDIT_SUPPRESS_RC
) ) {
2032 global $wgUseRCPatrol, $wgUseNPPatrol;
2033 # Mark as patrolled if the user can do so
2034 $patrolled = ($wgUseRCPatrol ||
$wgUseNPPatrol) && $this->mTitle
->userCan('autopatrol');
2035 # Add RC row to the DB
2036 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
2037 '', strlen($text), $revisionId, $patrolled );
2038 # Log auto-patrolled edits
2040 PatrolLog
::record( $rc, true );
2043 $user->incEditCount();
2046 # Update links, etc.
2047 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, true );
2050 Article
::onArticleCreate( $this->mTitle
);
2052 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
2053 $flags & EDIT_MINOR
, null, null, &$flags, $revision ) );
2056 # Do updates right now unless deferral was requested
2057 if( !( $flags & EDIT_DEFER_UPDATES
) ) {
2061 // Return the new revision (or null) to the caller
2062 $status->value
['revision'] = $revision;
2064 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
2065 $flags & EDIT_MINOR
, null, null, &$flags, $revision, &$status, $baseRevId ) );
2067 wfProfileOut( __METHOD__
);
2072 * @deprecated wrapper for doRedirect
2074 public function showArticle( $text, $subtitle , $sectionanchor = '', $me2, $now, $summary, $oldid ) {
2075 wfDeprecated( __METHOD__
);
2076 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor );
2080 * Output a redirect back to the article.
2081 * This is typically used after an edit.
2083 * @param $noRedir Boolean: add redirect=no
2084 * @param $sectionAnchor String: section to redirect to, including "#"
2085 * @param $extraQuery String: extra query params
2087 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
2090 $query = 'redirect=no';
2092 $query .= "&$query";
2094 $query = $extraQuery;
2096 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $sectionAnchor );
2100 * Mark this particular edit/page as patrolled
2102 public function markpatrolled() {
2103 global $wgOut, $wgRequest, $wgUseRCPatrol, $wgUseNPPatrol, $wgUser;
2104 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2106 # If we haven't been given an rc_id value, we can't do anything
2107 $rcid = (int) $wgRequest->getVal('rcid');
2108 $rc = RecentChange
::newFromId($rcid);
2109 if( is_null($rc) ) {
2110 $wgOut->showErrorPage( 'markedaspatrollederror', 'markedaspatrollederrortext' );
2114 #It would be nice to see where the user had actually come from, but for now just guess
2115 $returnto = $rc->getAttribute( 'rc_type' ) == RC_NEW ?
'Newpages' : 'Recentchanges';
2116 $return = SpecialPage
::getTitleFor( $returnto );
2118 $dbw = wfGetDB( DB_MASTER
);
2119 $errors = $rc->doMarkPatrolled();
2121 if( in_array(array('rcpatroldisabled'), $errors) ) {
2122 $wgOut->showErrorPage( 'rcpatroldisabled', 'rcpatroldisabledtext' );
2126 if( in_array(array('hookaborted'), $errors) ) {
2127 // The hook itself has handled any output
2131 if( in_array(array('markedaspatrollederror-noautopatrol'), $errors) ) {
2132 $wgOut->setPageTitle( wfMsg( 'markedaspatrollederror' ) );
2133 $wgOut->addWikiMsg( 'markedaspatrollederror-noautopatrol' );
2134 $wgOut->returnToMain( false, $return );
2138 if( !empty($errors) ) {
2139 $wgOut->showPermissionsErrorPage( $errors );
2144 $wgOut->setPageTitle( wfMsg( 'markedaspatrolled' ) );
2145 $wgOut->addWikiMsg( 'markedaspatrolledtext' );
2146 $wgOut->returnToMain( false, $return );
2150 * User-interface handler for the "watch" action
2153 public function watch() {
2154 global $wgUser, $wgOut;
2155 if( $wgUser->isAnon() ) {
2156 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2159 if( wfReadOnly() ) {
2160 $wgOut->readOnlyPage();
2163 if( $this->doWatch() ) {
2164 $wgOut->setPagetitle( wfMsg( 'addedwatch' ) );
2165 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2166 $wgOut->addWikiMsg( 'addedwatchtext', $this->mTitle
->getPrefixedText() );
2168 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2172 * Add this page to $wgUser's watchlist
2173 * @return bool true on successful watch operation
2175 public function doWatch() {
2177 if( $wgUser->isAnon() ) {
2180 if( wfRunHooks('WatchArticle', array(&$wgUser, &$this)) ) {
2181 $wgUser->addWatch( $this->mTitle
);
2182 return wfRunHooks('WatchArticleComplete', array(&$wgUser, &$this));
2188 * User interface handler for the "unwatch" action.
2190 public function unwatch() {
2191 global $wgUser, $wgOut;
2192 if( $wgUser->isAnon() ) {
2193 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2196 if( wfReadOnly() ) {
2197 $wgOut->readOnlyPage();
2200 if( $this->doUnwatch() ) {
2201 $wgOut->setPagetitle( wfMsg( 'removedwatch' ) );
2202 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2203 $wgOut->addWikiMsg( 'removedwatchtext', $this->mTitle
->getPrefixedText() );
2205 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2209 * Stop watching a page
2210 * @return bool true on successful unwatch
2212 public function doUnwatch() {
2214 if( $wgUser->isAnon() ) {
2217 if( wfRunHooks('UnwatchArticle', array(&$wgUser, &$this)) ) {
2218 $wgUser->removeWatch( $this->mTitle
);
2219 return wfRunHooks('UnwatchArticleComplete', array(&$wgUser, &$this));
2225 * action=protect handler
2227 public function protect() {
2228 $form = new ProtectionForm( $this );
2233 * action=unprotect handler (alias)
2235 public function unprotect() {
2240 * Update the article's restriction field, and leave a log entry.
2242 * @param $limit Array: set of restriction keys
2243 * @param $reason String
2244 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2245 * @param $expiry Array: per restriction type expiration
2246 * @return bool true on success
2248 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
2249 global $wgUser, $wgRestrictionTypes, $wgContLang;
2251 $id = $this->mTitle
->getArticleID();
2253 wfDebug( "updateRestrictions failed: $id <= 0\n" );
2257 if ( wfReadOnly() ) {
2258 wfDebug( "updateRestrictions failed: read-only\n" );
2262 if ( !$this->mTitle
->userCan( 'protect' ) ) {
2263 wfDebug( "updateRestrictions failed: insufficient permissions\n" );
2271 // Take this opportunity to purge out expired restrictions
2272 Title
::purgeExpiredRestrictions();
2274 # FIXME: Same limitations as described in ProtectionForm.php (line 37);
2275 # we expect a single selection, but the schema allows otherwise.
2277 $updated = Article
::flattenRestrictions( $limit );
2279 foreach( $wgRestrictionTypes as $action ) {
2280 if( isset( $expiry[$action] ) ) {
2281 # Get current restrictions on $action
2282 $aLimits = $this->mTitle
->getRestrictions( $action );
2283 $current[$action] = implode( '', $aLimits );
2284 # Are any actual restrictions being dealt with here?
2285 $aRChanged = count($aLimits) ||
!empty($limit[$action]);
2286 # If something changed, we need to log it. Checking $aRChanged
2287 # assures that "unprotecting" a page that is not protected does
2288 # not log just because the expiry was "changed".
2289 if( $aRChanged && $this->mTitle
->mRestrictionsExpiry
[$action] != $expiry[$action] ) {
2295 $current = Article
::flattenRestrictions( $current );
2297 $changed = ($changed ||
$current != $updated );
2298 $changed = $changed ||
($updated && $this->mTitle
->areRestrictionsCascading() != $cascade);
2299 $protect = ( $updated != '' );
2301 # If nothing's changed, do nothing
2303 if( wfRunHooks( 'ArticleProtect', array( &$this, &$wgUser, $limit, $reason ) ) ) {
2305 $dbw = wfGetDB( DB_MASTER
);
2307 # Prepare a null revision to be added to the history
2308 $modified = $current != '' && $protect;
2310 $comment_type = $modified ?
'modifiedarticleprotection' : 'protectedarticle';
2312 $comment_type = 'unprotectedarticle';
2314 $comment = $wgContLang->ucfirst( wfMsgForContent( $comment_type, $this->mTitle
->getPrefixedText() ) );
2316 # Only restrictions with the 'protect' right can cascade...
2317 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
2318 $editrestriction = isset( $limit['edit'] ) ?
array( $limit['edit'] ) : $this->mTitle
->getRestrictions( 'edit' );
2319 # The schema allows multiple restrictions
2320 if(!in_array('protect', $editrestriction) && !in_array('sysop', $editrestriction))
2322 $cascade_description = '';
2324 $cascade_description = ' ['.wfMsgForContent('protect-summary-cascade').']';
2328 $comment .= ": $reason";
2330 $editComment = $comment;
2331 $encodedExpiry = array();
2332 $protect_description = '';
2333 foreach( $limit as $action => $restrictions ) {
2334 if ( !isset($expiry[$action]) )
2335 $expiry[$action] = 'infinite';
2337 $encodedExpiry[$action] = Block
::encodeExpiry($expiry[$action], $dbw );
2338 if( $restrictions != '' ) {
2339 $protect_description .= "[$action=$restrictions] (";
2340 if( $encodedExpiry[$action] != 'infinity' ) {
2341 $protect_description .= wfMsgForContent( 'protect-expiring',
2342 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
2343 $wgContLang->date( $expiry[$action], false, false ) ,
2344 $wgContLang->time( $expiry[$action], false, false ) );
2346 $protect_description .= wfMsgForContent( 'protect-expiry-indefinite' );
2348 $protect_description .= ') ';
2351 $protect_description = trim($protect_description);
2353 if( $protect_description && $protect )
2354 $editComment .= " ($protect_description)";
2356 $editComment .= "$cascade_description";
2357 # Update restrictions table
2358 foreach( $limit as $action => $restrictions ) {
2359 if($restrictions != '' ) {
2360 $dbw->replace( 'page_restrictions', array(array('pr_page', 'pr_type')),
2361 array( 'pr_page' => $id,
2362 'pr_type' => $action,
2363 'pr_level' => $restrictions,
2364 'pr_cascade' => ($cascade && $action == 'edit') ?
1 : 0,
2365 'pr_expiry' => $encodedExpiry[$action] ), __METHOD__
);
2367 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2368 'pr_type' => $action ), __METHOD__
);
2372 # Insert a null revision
2373 $nullRevision = Revision
::newNullRevision( $dbw, $id, $editComment, true );
2374 $nullRevId = $nullRevision->insertOn( $dbw );
2376 $latest = $this->getLatest();
2377 # Update page record
2378 $dbw->update( 'page',
2380 'page_touched' => $dbw->timestamp(),
2381 'page_restrictions' => '',
2382 'page_latest' => $nullRevId
2383 ), array( /* WHERE */
2385 ), 'Article::protect'
2388 wfRunHooks( 'NewRevisionFromEditComplete', array($this, $nullRevision, $latest, $wgUser) );
2389 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$wgUser, $limit, $reason ) );
2391 # Update the protection log
2392 $log = new LogPage( 'protect' );
2394 $params = array($protect_description,$cascade ?
'cascade' : '');
2395 $log->addEntry( $modified ?
'modify' : 'protect', $this->mTitle
, trim( $reason), $params );
2397 $log->addEntry( 'unprotect', $this->mTitle
, $reason );
2401 } # End "changed" check
2407 * Take an array of page restrictions and flatten it to a string
2408 * suitable for insertion into the page_restrictions field.
2409 * @param $limit Array
2412 protected static function flattenRestrictions( $limit ) {
2413 if( !is_array( $limit ) ) {
2414 throw new MWException( 'Article::flattenRestrictions given non-array restriction set' );
2418 foreach( $limit as $action => $restrictions ) {
2419 if( $restrictions != '' ) {
2420 $bits[] = "$action=$restrictions";
2423 return implode( ':', $bits );
2427 * Auto-generates a deletion reason
2428 * @param &$hasHistory Boolean: whether the page has a history
2430 public function generateReason( &$hasHistory ) {
2432 $dbw = wfGetDB( DB_MASTER
);
2433 // Get the last revision
2434 $rev = Revision
::newFromTitle( $this->mTitle
);
2435 if( is_null( $rev ) )
2438 // Get the article's contents
2439 $contents = $rev->getText();
2441 // If the page is blank, use the text from the previous revision,
2442 // which can only be blank if there's a move/import/protect dummy revision involved
2443 if( $contents == '' ) {
2444 $prev = $rev->getPrevious();
2446 $contents = $prev->getText();
2451 // Find out if there was only one contributor
2452 // Only scan the last 20 revisions
2453 $res = $dbw->select( 'revision', 'rev_user_text',
2454 array( 'rev_page' => $this->getID(), $dbw->bitAnd('rev_deleted', Revision
::DELETED_USER
) . ' = 0' ),
2456 array( 'LIMIT' => 20 )
2458 if( $res === false )
2459 // This page has no revisions, which is very weird
2462 $hasHistory = ( $res->numRows() > 1 );
2463 $row = $dbw->fetchObject( $res );
2464 $onlyAuthor = $row->rev_user_text
;
2465 // Try to find a second contributor
2466 foreach( $res as $row ) {
2467 if( $row->rev_user_text
!= $onlyAuthor ) {
2468 $onlyAuthor = false;
2472 $dbw->freeResult( $res );
2474 // Generate the summary with a '$1' placeholder
2476 // The current revision is blank and the one before is also
2477 // blank. It's just not our lucky day
2478 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2481 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2483 $reason = wfMsgForContent( 'excontent', '$1' );
2486 if( $reason == '-' ) {
2487 // Allow these UI messages to be blanked out cleanly
2491 // Replace newlines with spaces to prevent uglyness
2492 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2493 // Calculate the maximum amount of chars to get
2494 // Max content length = max comment length - length of the comment (excl. $1) - '...'
2495 $maxLength = 255 - (strlen( $reason ) - 2) - 3;
2496 $contents = $wgContLang->truncate( $contents, $maxLength );
2497 // Remove possible unfinished links
2498 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2499 // Now replace the '$1' placeholder
2500 $reason = str_replace( '$1', $contents, $reason );
2506 * UI entry point for page deletion
2508 public function delete() {
2509 global $wgUser, $wgOut, $wgRequest;
2511 $confirm = $wgRequest->wasPosted() &&
2512 $wgUser->matchEditToken( $wgRequest->getVal( 'wpEditToken' ) );
2514 $this->DeleteReasonList
= $wgRequest->getText( 'wpDeleteReasonList', 'other' );
2515 $this->DeleteReason
= $wgRequest->getText( 'wpReason' );
2517 $reason = $this->DeleteReasonList
;
2519 if( $reason != 'other' && $this->DeleteReason
!= '' ) {
2520 // Entry from drop down menu + additional comment
2521 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason
;
2522 } elseif( $reason == 'other' ) {
2523 $reason = $this->DeleteReason
;
2525 # Flag to hide all contents of the archived revisions
2526 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
2528 # This code desperately needs to be totally rewritten
2530 # Read-only check...
2531 if( wfReadOnly() ) {
2532 $wgOut->readOnlyPage();
2537 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
2539 if( count( $permission_errors ) > 0 ) {
2540 $wgOut->showPermissionsErrorPage( $permission_errors );
2544 $wgOut->setPagetitle( wfMsg( 'delete-confirm', $this->mTitle
->getPrefixedText() ) );
2546 # Better double-check that it hasn't been deleted yet!
2547 $dbw = wfGetDB( DB_MASTER
);
2548 $conds = $this->mTitle
->pageCond();
2549 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
2550 if( $latest === false ) {
2551 $wgOut->showFatalError( wfMsgExt( 'cannotdelete', array( 'parse' ) ) );
2552 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2553 LogEventsList
::showLogExtract( $wgOut, 'delete', $this->mTitle
->getPrefixedText() );
2557 # Hack for big sites
2558 $bigHistory = $this->isBigDeletion();
2559 if( $bigHistory && !$this->mTitle
->userCan( 'bigdelete' ) ) {
2560 global $wgLang, $wgDeleteRevisionsLimit;
2561 $wgOut->wrapWikiMsg( "<div class='error'>\n$1</div>\n",
2562 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2567 $this->doDelete( $reason, $suppress );
2568 if( $wgRequest->getCheck( 'wpWatch' ) ) {
2570 } elseif( $this->mTitle
->userIsWatching() ) {
2576 // Generate deletion reason
2577 $hasHistory = false;
2578 if( !$reason ) $reason = $this->generateReason($hasHistory);
2580 // If the page has a history, insert a warning
2581 if( $hasHistory && !$confirm ) {
2582 $skin = $wgUser->getSkin();
2583 $wgOut->addHTML( '<strong>' . wfMsgExt( 'historywarning', array( 'parseinline' ) ) . ' ' . $skin->historyLink() . '</strong>' );
2585 global $wgLang, $wgDeleteRevisionsLimit;
2586 $wgOut->wrapWikiMsg( "<div class='error'>\n$1</div>\n",
2587 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2591 return $this->confirmDelete( $reason );
2595 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
2597 public function isBigDeletion() {
2598 global $wgDeleteRevisionsLimit;
2599 if( $wgDeleteRevisionsLimit ) {
2600 $revCount = $this->estimateRevisionCount();
2601 return $revCount > $wgDeleteRevisionsLimit;
2607 * @return int approximate revision count
2609 public function estimateRevisionCount() {
2610 $dbr = wfGetDB( DB_SLAVE
);
2611 // For an exact count...
2612 //return $dbr->selectField( 'revision', 'COUNT(*)',
2613 // array( 'rev_page' => $this->getId() ), __METHOD__ );
2614 return $dbr->estimateRowCount( 'revision', '*',
2615 array( 'rev_page' => $this->getId() ), __METHOD__
);
2619 * Get the last N authors
2620 * @param $num Integer: number of revisions to get
2621 * @param $revLatest String: the latest rev_id, selected from the master (optional)
2622 * @return array Array of authors, duplicates not removed
2624 public function getLastNAuthors( $num, $revLatest = 0 ) {
2625 wfProfileIn( __METHOD__
);
2626 // First try the slave
2627 // If that doesn't have the latest revision, try the master
2629 $db = wfGetDB( DB_SLAVE
);
2631 $res = $db->select( array( 'page', 'revision' ),
2632 array( 'rev_id', 'rev_user_text' ),
2634 'page_namespace' => $this->mTitle
->getNamespace(),
2635 'page_title' => $this->mTitle
->getDBkey(),
2636 'rev_page = page_id'
2637 ), __METHOD__
, $this->getSelectOptions( array(
2638 'ORDER BY' => 'rev_timestamp DESC',
2643 wfProfileOut( __METHOD__
);
2646 $row = $db->fetchObject( $res );
2647 if( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
2648 $db = wfGetDB( DB_MASTER
);
2653 } while ( $continue );
2655 $authors = array( $row->rev_user_text
);
2656 while ( $row = $db->fetchObject( $res ) ) {
2657 $authors[] = $row->rev_user_text
;
2659 wfProfileOut( __METHOD__
);
2664 * Output deletion confirmation dialog
2665 * @param $reason String: prefilled reason
2667 public function confirmDelete( $reason ) {
2668 global $wgOut, $wgUser;
2670 wfDebug( "Article::confirmDelete\n" );
2672 $deleteBackLink = $wgUser->getSkin()->link(
2677 array( 'known', 'noclasses' )
2679 $wgOut->setSubtitle( wfMsgHtml( 'delete-backlink', $deleteBackLink ) );
2680 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2681 $wgOut->addWikiMsg( 'confirmdeletetext' );
2683 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
2685 if( $wgUser->isAllowed( 'suppressrevision' ) ) {
2686 $suppress = "<tr id=\"wpDeleteSuppressRow\" name=\"wpDeleteSuppressRow\">
2688 <td class='mw-input'><strong>" .
2689 Xml
::checkLabel( wfMsg( 'revdelete-suppress' ),
2690 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
2696 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) ||
$this->mTitle
->userIsWatching();
2698 $form = Xml
::openElement( 'form', array( 'method' => 'post',
2699 'action' => $this->mTitle
->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
2700 Xml
::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
2701 Xml
::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
2702 Xml
::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
2703 "<tr id=\"wpDeleteReasonListRow\">
2704 <td class='mw-label'>" .
2705 Xml
::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
2707 <td class='mw-input'>" .
2708 Xml
::listDropDown( 'wpDeleteReasonList',
2709 wfMsgForContent( 'deletereason-dropdown' ),
2710 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
2713 <tr id=\"wpDeleteReasonRow\">
2714 <td class='mw-label'>" .
2715 Xml
::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
2717 <td class='mw-input'>" .
2718 Html
::input( 'wpReason', $reason, 'text', array(
2720 'maxlength' => '255',
2729 <td class='mw-input'>" .
2730 Xml
::checkLabel( wfMsg( 'watchthis' ),
2731 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
2737 <td class='mw-submit'>" .
2738 Xml
::submitButton( wfMsg( 'deletepage' ),
2739 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
2742 Xml
::closeElement( 'table' ) .
2743 Xml
::closeElement( 'fieldset' ) .
2744 Xml
::hidden( 'wpEditToken', $wgUser->editToken() ) .
2745 Xml
::closeElement( 'form' );
2747 if( $wgUser->isAllowed( 'editinterface' ) ) {
2748 $skin = $wgUser->getSkin();
2749 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Deletereason-dropdown' );
2750 $link = $skin->link(
2752 wfMsgHtml( 'delete-edit-reasonlist' ),
2754 array( 'action' => 'edit' )
2756 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
2759 $wgOut->addHTML( $form );
2760 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2761 LogEventsList
::showLogExtract( $wgOut, 'delete', $this->mTitle
->getPrefixedText() );
2765 * Perform a deletion and output success or failure messages
2767 public function doDelete( $reason, $suppress = false ) {
2768 global $wgOut, $wgUser;
2769 $id = $this->mTitle
->getArticleID( GAID_FOR_UPDATE
);
2772 if( wfRunHooks('ArticleDelete', array(&$this, &$wgUser, &$reason, &$error)) ) {
2773 if( $this->doDeleteArticle( $reason, $suppress, $id ) ) {
2774 $deleted = $this->mTitle
->getPrefixedText();
2776 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
2777 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2779 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
2781 $wgOut->addWikiMsg( 'deletedtext', $deleted, $loglink );
2782 $wgOut->returnToMain( false );
2783 wfRunHooks('ArticleDeleteComplete', array(&$this, &$wgUser, $reason, $id));
2786 if( $error == '' ) {
2787 $wgOut->showFatalError( wfMsgExt( 'cannotdelete', array( 'parse' ) ) );
2788 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2789 LogEventsList
::showLogExtract( $wgOut, 'delete', $this->mTitle
->getPrefixedText() );
2791 $wgOut->showFatalError( $error );
2797 * Back-end article deletion
2798 * Deletes the article with database consistency, writes logs, purges caches
2801 public function doDeleteArticle( $reason, $suppress = false, $id = 0 ) {
2802 global $wgUseSquid, $wgDeferredUpdateList;
2803 global $wgUseTrackbacks;
2805 wfDebug( __METHOD__
."\n" );
2807 $dbw = wfGetDB( DB_MASTER
);
2808 $ns = $this->mTitle
->getNamespace();
2809 $t = $this->mTitle
->getDBkey();
2810 $id = $id ?
$id : $this->mTitle
->getArticleID( GAID_FOR_UPDATE
);
2812 if( $t == '' ||
$id == 0 ) {
2816 $u = new SiteStatsUpdate( 0, 1, -(int)$this->isCountable( $this->getRawText() ), -1 );
2817 array_push( $wgDeferredUpdateList, $u );
2819 // Bitfields to further suppress the content
2822 // This should be 15...
2823 $bitfield |
= Revision
::DELETED_TEXT
;
2824 $bitfield |
= Revision
::DELETED_COMMENT
;
2825 $bitfield |
= Revision
::DELETED_USER
;
2826 $bitfield |
= Revision
::DELETED_RESTRICTED
;
2828 $bitfield = 'rev_deleted';
2832 // For now, shunt the revision data into the archive table.
2833 // Text is *not* removed from the text table; bulk storage
2834 // is left intact to avoid breaking block-compression or
2835 // immutable storage schemes.
2837 // For backwards compatibility, note that some older archive
2838 // table entries will have ar_text and ar_flags fields still.
2840 // In the future, we may keep revisions and mark them with
2841 // the rev_deleted field, which is reserved for this purpose.
2842 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
2844 'ar_namespace' => 'page_namespace',
2845 'ar_title' => 'page_title',
2846 'ar_comment' => 'rev_comment',
2847 'ar_user' => 'rev_user',
2848 'ar_user_text' => 'rev_user_text',
2849 'ar_timestamp' => 'rev_timestamp',
2850 'ar_minor_edit' => 'rev_minor_edit',
2851 'ar_rev_id' => 'rev_id',
2852 'ar_text_id' => 'rev_text_id',
2853 'ar_text' => '\'\'', // Be explicit to appease
2854 'ar_flags' => '\'\'', // MySQL's "strict mode"...
2855 'ar_len' => 'rev_len',
2856 'ar_page_id' => 'page_id',
2857 'ar_deleted' => $bitfield
2860 'page_id = rev_page'
2864 # Delete restrictions for it
2865 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__
);
2867 # Now that it's safely backed up, delete it
2868 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
2869 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
2875 # Fix category table counts
2877 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__
);
2878 foreach( $res as $row ) {
2879 $cats []= $row->cl_to
;
2881 $this->updateCategoryCounts( array(), $cats );
2883 # If using cascading deletes, we can skip some explicit deletes
2884 if( !$dbw->cascadingDeletes() ) {
2885 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
2887 if($wgUseTrackbacks)
2888 $dbw->delete( 'trackbacks', array( 'tb_page' => $id ), __METHOD__
);
2890 # Delete outgoing links
2891 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ) );
2892 $dbw->delete( 'imagelinks', array( 'il_from' => $id ) );
2893 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ) );
2894 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ) );
2895 $dbw->delete( 'externallinks', array( 'el_from' => $id ) );
2896 $dbw->delete( 'langlinks', array( 'll_from' => $id ) );
2897 $dbw->delete( 'redirect', array( 'rd_from' => $id ) );
2900 # If using cleanup triggers, we can skip some manual deletes
2901 if( !$dbw->cleanupTriggers() ) {
2902 # Clean up recentchanges entries...
2903 $dbw->delete( 'recentchanges',
2904 array( 'rc_type != '.RC_LOG
,
2905 'rc_namespace' => $this->mTitle
->getNamespace(),
2906 'rc_title' => $this->mTitle
->getDBkey() ),
2908 $dbw->delete( 'recentchanges',
2909 array( 'rc_type != '.RC_LOG
, 'rc_cur_id' => $id ),
2914 Article
::onArticleDelete( $this->mTitle
);
2916 # Clear the cached article id so the interface doesn't act like we exist
2917 $this->mTitle
->resetArticleID( 0 );
2919 # Log the deletion, if the page was suppressed, log it at Oversight instead
2920 $logtype = $suppress ?
'suppress' : 'delete';
2921 $log = new LogPage( $logtype );
2923 # Make sure logging got through
2924 $log->addEntry( 'delete', $this->mTitle
, $reason, array() );
2932 * Roll back the most recent consecutive set of edits to a page
2933 * from the same user; fails if there are no eligible edits to
2934 * roll back to, e.g. user is the sole contributor. This function
2935 * performs permissions checks on $wgUser, then calls commitRollback()
2936 * to do the dirty work
2938 * @param $fromP String: Name of the user whose edits to rollback.
2939 * @param $summary String: Custom summary. Set to default summary if empty.
2940 * @param $token String: Rollback token.
2941 * @param $bot Boolean: If true, mark all reverted edits as bot.
2943 * @param $resultDetails Array: contains result-specific array of additional values
2944 * 'alreadyrolled' : 'current' (rev)
2945 * success : 'summary' (str), 'current' (rev), 'target' (rev)
2947 * @return array of errors, each error formatted as
2948 * array(messagekey, param1, param2, ...).
2949 * On success, the array is empty. This array can also be passed to
2950 * OutputPage::showPermissionsErrorPage().
2952 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails ) {
2954 $resultDetails = null;
2957 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
2958 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $wgUser );
2959 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
2961 if( !$wgUser->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) )
2962 $errors[] = array( 'sessionfailure' );
2964 if( $wgUser->pingLimiter( 'rollback' ) ||
$wgUser->pingLimiter() ) {
2965 $errors[] = array( 'actionthrottledtext' );
2967 # If there were errors, bail out now
2968 if( !empty( $errors ) )
2971 return $this->commitRollback($fromP, $summary, $bot, $resultDetails);
2975 * Backend implementation of doRollback(), please refer there for parameter
2976 * and return value documentation
2978 * NOTE: This function does NOT check ANY permissions, it just commits the
2979 * rollback to the DB Therefore, you should only call this function direct-
2980 * ly if you want to use custom permissions checks. If you don't, use
2981 * doRollback() instead.
2983 public function commitRollback($fromP, $summary, $bot, &$resultDetails) {
2984 global $wgUseRCPatrol, $wgUser, $wgLang;
2985 $dbw = wfGetDB( DB_MASTER
);
2987 if( wfReadOnly() ) {
2988 return array( array( 'readonlytext' ) );
2991 # Get the last editor
2992 $current = Revision
::newFromTitle( $this->mTitle
);
2993 if( is_null( $current ) ) {
2994 # Something wrong... no page?
2995 return array(array('notanarticle'));
2998 $from = str_replace( '_', ' ', $fromP );
2999 # User name given should match up with the top revision.
3000 # If the user was deleted then $from should be empty.
3001 if( $from != $current->getUserText() ) {
3002 $resultDetails = array( 'current' => $current );
3003 return array(array('alreadyrolled',
3004 htmlspecialchars($this->mTitle
->getPrefixedText()),
3005 htmlspecialchars($fromP),
3006 htmlspecialchars($current->getUserText())
3010 # Get the last edit not by this guy...
3011 # Note: these may not be public values
3012 $user = intval( $current->getRawUser() );
3013 $user_text = $dbw->addQuotes( $current->getRawUserText() );
3014 $s = $dbw->selectRow( 'revision',
3015 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3016 array( 'rev_page' => $current->getPage(),
3017 "rev_user != {$user} OR rev_user_text != {$user_text}"
3019 array( 'USE INDEX' => 'page_timestamp',
3020 'ORDER BY' => 'rev_timestamp DESC' )
3022 if( $s === false ) {
3023 # No one else ever edited this page
3024 return array(array('cantrollback'));
3025 } else if( $s->rev_deleted
& REVISION
::DELETED_TEXT ||
$s->rev_deleted
& REVISION
::DELETED_USER
) {
3026 # Only admins can see this text
3027 return array(array('notvisiblerev'));
3031 if( $bot && $wgUser->isAllowed('markbotedits') ) {
3032 # Mark all reverted edits as bot
3035 if( $wgUseRCPatrol ) {
3036 # Mark all reverted edits as patrolled
3037 $set['rc_patrolled'] = 1;
3041 $dbw->update( 'recentchanges', $set,
3043 'rc_cur_id' => $current->getPage(),
3044 'rc_user_text' => $current->getUserText(),
3045 "rc_timestamp > '{$s->rev_timestamp}'",
3050 # Generate the edit summary if necessary
3051 $target = Revision
::newFromId( $s->rev_id
);
3052 if( empty( $summary ) ) {
3053 if( $from == '' ) { // no public user name
3054 $summary = wfMsgForContent( 'revertpage-nouser' );
3056 $summary = wfMsgForContent( 'revertpage' );
3060 # Allow the custom summary to use the same args as the default message
3062 $target->getUserText(), $from, $s->rev_id
,
3063 $wgLang->timeanddate(wfTimestamp(TS_MW
, $s->rev_timestamp
), true),
3064 $current->getId(), $wgLang->timeanddate($current->getTimestamp())
3066 $summary = wfMsgReplaceArgs( $summary, $args );
3069 $flags = EDIT_UPDATE
;
3071 if( $wgUser->isAllowed('minoredit') )
3072 $flags |
= EDIT_MINOR
;
3074 if( $bot && ($wgUser->isAllowed('markbotedits') ||
$wgUser->isAllowed('bot')) )
3075 $flags |
= EDIT_FORCE_BOT
;
3076 # Actually store the edit
3077 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
3078 if( !empty( $status->value
['revision'] ) ) {
3079 $revId = $status->value
['revision']->getId();
3084 wfRunHooks( 'ArticleRollbackComplete', array( $this, $wgUser, $target, $current ) );
3086 $resultDetails = array(
3087 'summary' => $summary,
3088 'current' => $current,
3089 'target' => $target,
3096 * User interface for rollback operations
3098 public function rollback() {
3099 global $wgUser, $wgOut, $wgRequest, $wgUseRCPatrol;
3102 $result = $this->doRollback(
3103 $wgRequest->getVal( 'from' ),
3104 $wgRequest->getText( 'summary' ),
3105 $wgRequest->getVal( 'token' ),
3106 $wgRequest->getBool( 'bot' ),
3110 if( in_array( array( 'actionthrottledtext' ), $result ) ) {
3111 $wgOut->rateLimited();
3114 if( isset( $result[0][0] ) && ( $result[0][0] == 'alreadyrolled' ||
$result[0][0] == 'cantrollback' ) ) {
3115 $wgOut->setPageTitle( wfMsg( 'rollbackfailed' ) );
3116 $errArray = $result[0];
3117 $errMsg = array_shift( $errArray );
3118 $wgOut->addWikiMsgArray( $errMsg, $errArray );
3119 if( isset( $details['current'] ) ){
3120 $current = $details['current'];
3121 if( $current->getComment() != '' ) {
3122 $wgOut->addWikiMsgArray( 'editcomment', array(
3123 $wgUser->getSkin()->formatComment( $current->getComment() ) ), array( 'replaceafter' ) );
3128 # Display permissions errors before read-only message -- there's no
3129 # point in misleading the user into thinking the inability to rollback
3130 # is only temporary.
3131 if( !empty( $result ) && $result !== array( array( 'readonlytext' ) ) ) {
3132 # array_diff is completely broken for arrays of arrays, sigh. Re-
3133 # move any 'readonlytext' error manually.
3135 foreach( $result as $error ) {
3136 if( $error != array( 'readonlytext' ) ) {
3140 $wgOut->showPermissionsErrorPage( $out );
3143 if( $result == array( array( 'readonlytext' ) ) ) {
3144 $wgOut->readOnlyPage();
3148 $current = $details['current'];
3149 $target = $details['target'];
3150 $newId = $details['newid'];
3151 $wgOut->setPageTitle( wfMsg( 'actioncomplete' ) );
3152 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3153 $old = $wgUser->getSkin()->userLink( $current->getUser(), $current->getUserText() )
3154 . $wgUser->getSkin()->userToolLinks( $current->getUser(), $current->getUserText() );
3155 $new = $wgUser->getSkin()->userLink( $target->getUser(), $target->getUserText() )
3156 . $wgUser->getSkin()->userToolLinks( $target->getUser(), $target->getUserText() );
3157 $wgOut->addHTML( wfMsgExt( 'rollback-success', array( 'parse', 'replaceafter' ), $old, $new ) );
3158 $wgOut->returnToMain( false, $this->mTitle
);
3160 if( !$wgRequest->getBool( 'hidediff', false ) && !$wgUser->getBoolOption( 'norollbackdiff', false ) ) {
3161 $de = new DifferenceEngine( $this->mTitle
, $current->getId(), $newId, false, true );
3162 $de->showDiff( '', '' );
3168 * Do standard deferred updates after page view
3170 public function viewUpdates() {
3171 global $wgDeferredUpdateList, $wgDisableCounters, $wgUser;
3172 if ( wfReadOnly() ) {
3175 # Don't update page view counters on views from bot users (bug 14044)
3176 if( !$wgDisableCounters && !$wgUser->isAllowed('bot') && $this->getID() ) {
3177 Article
::incViewCount( $this->getID() );
3178 $u = new SiteStatsUpdate( 1, 0, 0 );
3179 array_push( $wgDeferredUpdateList, $u );
3181 # Update newtalk / watchlist notification status
3182 $wgUser->clearNotification( $this->mTitle
);
3186 * Prepare text which is about to be saved.
3187 * Returns a stdclass with source, pst and output members
3189 public function prepareTextForEdit( $text, $revid=null ) {
3190 if( $this->mPreparedEdit
&& $this->mPreparedEdit
->newText
== $text && $this->mPreparedEdit
->revid
== $revid) {
3192 return $this->mPreparedEdit
;
3195 $edit = (object)array();
3196 $edit->revid
= $revid;
3197 $edit->newText
= $text;
3198 $edit->pst
= $this->preSaveTransform( $text );
3199 $options = $this->getParserOptions();
3200 $edit->output
= $wgParser->parse( $edit->pst
, $this->mTitle
, $options, true, true, $revid );
3201 $edit->oldText
= $this->getContent();
3202 $this->mPreparedEdit
= $edit;
3207 * Do standard deferred updates after page edit.
3208 * Update links tables, site stats, search index and message cache.
3209 * Purges pages that include this page if the text was changed here.
3210 * Every 100th edit, prune the recent changes table.
3213 * @param $text New text of the article
3214 * @param $summary Edit summary
3215 * @param $minoredit Minor edit
3216 * @param $timestamp_of_pagechange Timestamp associated with the page change
3217 * @param $newid rev_id value of the new revision
3218 * @param $changed Whether or not the content actually changed
3220 public function editUpdates( $text, $summary, $minoredit, $timestamp_of_pagechange, $newid, $changed = true ) {
3221 global $wgDeferredUpdateList, $wgMessageCache, $wgUser, $wgParser, $wgEnableParserCache;
3223 wfProfileIn( __METHOD__
);
3226 # Be careful not to double-PST: $text is usually already PST-ed once
3227 if( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
3228 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
3229 $editInfo = $this->prepareTextForEdit( $text, $newid );
3231 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
3232 $editInfo = $this->mPreparedEdit
;
3235 # Save it to the parser cache
3236 if( $wgEnableParserCache ) {
3237 $popts = $this->getParserOptions();
3238 $parserCache = ParserCache
::singleton();
3239 $parserCache->save( $editInfo->output
, $this, $popts );
3242 # Update the links tables
3243 $u = new LinksUpdate( $this->mTitle
, $editInfo->output
);
3246 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $changed ) );
3248 if( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
3249 if( 0 == mt_rand( 0, 99 ) ) {
3250 // Flush old entries from the `recentchanges` table; we do this on
3251 // random requests so as to avoid an increase in writes for no good reason
3253 $dbw = wfGetDB( DB_MASTER
);
3254 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
3255 $recentchanges = $dbw->tableName( 'recentchanges' );
3256 $sql = "DELETE FROM $recentchanges WHERE rc_timestamp < '{$cutoff}'";
3257 $dbw->query( $sql );
3261 $id = $this->getID();
3262 $title = $this->mTitle
->getPrefixedDBkey();
3263 $shortTitle = $this->mTitle
->getDBkey();
3266 wfProfileOut( __METHOD__
);
3270 $u = new SiteStatsUpdate( 0, 1, $this->mGoodAdjustment
, $this->mTotalAdjustment
);
3271 array_push( $wgDeferredUpdateList, $u );
3272 $u = new SearchUpdate( $id, $title, $text );
3273 array_push( $wgDeferredUpdateList, $u );
3275 # If this is another user's talk page, update newtalk
3276 # Don't do this if $changed = false otherwise some idiot can null-edit a
3277 # load of user talk pages and piss people off, nor if it's a minor edit
3278 # by a properly-flagged bot.
3279 if( $this->mTitle
->getNamespace() == NS_USER_TALK
&& $shortTitle != $wgUser->getTitleKey() && $changed
3280 && !( $minoredit && $wgUser->isAllowed( 'nominornewtalk' ) ) ) {
3281 if( wfRunHooks('ArticleEditUpdateNewTalk', array( &$this ) ) ) {
3282 $other = User
::newFromName( $shortTitle, false );
3284 wfDebug( __METHOD__
.": invalid username\n" );
3285 } elseif( User
::isIP( $shortTitle ) ) {
3286 // An anonymous user
3287 $other->setNewtalk( true );
3288 } elseif( $other->isLoggedIn() ) {
3289 $other->setNewtalk( true );
3291 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
3296 if( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
3297 $wgMessageCache->replace( $shortTitle, $text );
3300 wfProfileOut( __METHOD__
);
3304 * Perform article updates on a special page creation.
3306 * @param $rev Revision object
3308 * @todo This is a shitty interface function. Kill it and replace the
3309 * other shitty functions like editUpdates and such so it's not needed
3312 public function createUpdates( $rev ) {
3313 $this->mGoodAdjustment
= $this->isCountable( $rev->getText() );
3314 $this->mTotalAdjustment
= 1;
3315 $this->editUpdates( $rev->getText(), $rev->getComment(),
3316 $rev->isMinor(), wfTimestamp(), $rev->getId(), true );
3320 * Generate the navigation links when browsing through an article revisions
3321 * It shows the information as:
3322 * Revision as of \<date\>; view current revision
3323 * \<- Previous version | Next Version -\>
3325 * @param $oldid String: revision ID of this article revision
3327 public function setOldSubtitle( $oldid = 0 ) {
3328 global $wgLang, $wgOut, $wgUser, $wgRequest;
3330 if( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
3334 $revision = Revision
::newFromId( $oldid );
3336 $current = ( $oldid == $this->mLatest
);
3337 $td = $wgLang->timeanddate( $this->mTimestamp
, true );
3338 $tddate = $wgLang->date( $this->mTimestamp
, true );
3339 $tdtime = $wgLang->time( $this->mTimestamp
, true );
3340 $sk = $wgUser->getSkin();
3342 ?
wfMsgHtml( 'currentrevisionlink' )
3345 wfMsgHtml( 'currentrevisionlink' ),
3348 array( 'known', 'noclasses' )
3351 ?
wfMsgHtml( 'diff' )
3354 wfMsgHtml( 'diff' ),
3360 array( 'known', 'noclasses' )
3362 $prev = $this->mTitle
->getPreviousRevisionID( $oldid ) ;
3366 wfMsgHtml( 'previousrevision' ),
3369 'direction' => 'prev',
3372 array( 'known', 'noclasses' )
3374 : wfMsgHtml( 'previousrevision' );
3378 wfMsgHtml( 'diff' ),
3384 array( 'known', 'noclasses' )
3386 : wfMsgHtml( 'diff' );
3387 $nextlink = $current
3388 ?
wfMsgHtml( 'nextrevision' )
3391 wfMsgHtml( 'nextrevision' ),
3394 'direction' => 'next',
3397 array( 'known', 'noclasses' )
3399 $nextdiff = $current
3400 ?
wfMsgHtml( 'diff' )
3403 wfMsgHtml( 'diff' ),
3409 array( 'known', 'noclasses' )
3413 if( $wgUser->isAllowed( 'deleterevision' ) ) {
3414 $revdel = SpecialPage
::getTitleFor( 'Revisiondelete' );
3415 if( $revision->isCurrent() ) {
3416 // We don't handle top deleted edits too well
3417 $cdel = wfMsgHtml( 'rev-delundel' );
3418 } else if( !$revision->userCan( Revision
::DELETED_RESTRICTED
) ) {
3419 // If revision was hidden from sysops
3420 $cdel = wfMsgHtml( 'rev-delundel' );
3424 wfMsgHtml('rev-delundel'),
3427 'type' => 'revision',
3428 'target' => urlencode( $this->mTitle
->getPrefixedDbkey() ),
3429 'ids' => urlencode( $oldid )
3431 array( 'known', 'noclasses' )
3433 // Bolden oversighted content
3434 if( $revision->isDeleted( Revision
::DELETED_RESTRICTED
) )
3435 $cdel = "<strong>$cdel</strong>";
3437 $cdel = "(<small>$cdel</small>) ";
3439 $unhide = $wgRequest->getInt('unhide') == 1 && $wgUser->matchEditToken( $wgRequest->getVal('token'), $oldid );
3440 # Show user links if allowed to see them. If hidden, then show them only if requested...
3441 $userlinks = $sk->revUserTools( $revision, !$unhide );
3443 $m = wfMsg( 'revision-info-current' );
3444 $infomsg = $current && !wfEmptyMsg( 'revision-info-current', $m ) && $m != '-'
3445 ?
'revision-info-current'
3448 $r = "\n\t\t\t\t<div id=\"mw-{$infomsg}\">" .
3451 array( 'parseinline', 'replaceafter' ),
3457 $revision->getUser()
3460 "\n\t\t\t\t<div id=\"mw-revision-nav\">" . $cdel . wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
3461 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>\n\t\t\t";
3462 $wgOut->setSubtitle( $r );
3466 * This function is called right before saving the wikitext,
3467 * so we can do things like signatures and links-in-context.
3469 * @param $text String
3471 public function preSaveTransform( $text ) {
3472 global $wgParser, $wgUser;
3473 return $wgParser->preSaveTransform( $text, $this->mTitle
, $wgUser, ParserOptions
::newFromUser( $wgUser ) );
3476 /* Caching functions */
3479 * checkLastModified returns true if it has taken care of all
3480 * output to the client that is necessary for this request.
3481 * (that is, it has sent a cached version of the page)
3483 protected function tryFileCache() {
3484 static $called = false;
3486 wfDebug( "Article::tryFileCache(): called twice!?\n" );
3490 if( $this->isFileCacheable() ) {
3491 $cache = new HTMLFileCache( $this->mTitle
);
3492 if( $cache->isFileCacheGood( $this->mTouched
) ) {
3493 wfDebug( "Article::tryFileCache(): about to load file\n" );
3494 $cache->loadFromFileCache();
3497 wfDebug( "Article::tryFileCache(): starting buffer\n" );
3498 ob_start( array(&$cache, 'saveToFileCache' ) );
3501 wfDebug( "Article::tryFileCache(): not cacheable\n" );
3507 * Check if the page can be cached
3510 public function isFileCacheable() {
3512 if( HTMLFileCache
::useFileCache() ) {
3513 $cacheable = $this->getID() && !$this->mRedirectedFrom
;
3514 // Extension may have reason to disable file caching on some pages.
3516 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
3523 * Loads page_touched and returns a value indicating if it should be used
3526 public function checkTouched() {
3527 if( !$this->mDataLoaded
) {
3528 $this->loadPageData();
3530 return !$this->mIsRedirect
;
3534 * Get the page_touched field
3536 public function getTouched() {
3537 # Ensure that page data has been loaded
3538 if( !$this->mDataLoaded
) {
3539 $this->loadPageData();
3541 return $this->mTouched
;
3545 * Get the page_latest field
3547 public function getLatest() {
3548 if( !$this->mDataLoaded
) {
3549 $this->loadPageData();
3551 return (int)$this->mLatest
;
3555 * Edit an article without doing all that other stuff
3556 * The article must already exist; link tables etc
3557 * are not updated, caches are not flushed.
3559 * @param $text String: text submitted
3560 * @param $comment String: comment submitted
3561 * @param $minor Boolean: whereas it's a minor modification
3563 public function quickEdit( $text, $comment = '', $minor = 0 ) {
3564 wfProfileIn( __METHOD__
);
3566 $dbw = wfGetDB( DB_MASTER
);
3567 $revision = new Revision( array(
3568 'page' => $this->getId(),
3570 'comment' => $comment,
3571 'minor_edit' => $minor ?
1 : 0,
3573 $revision->insertOn( $dbw );
3574 $this->updateRevisionOn( $dbw, $revision );
3576 wfRunHooks( 'NewRevisionFromEditComplete', array($this, $revision, false, $wgUser) );
3578 wfProfileOut( __METHOD__
);
3582 * Used to increment the view counter
3584 * @param $id Integer: article id
3586 public static function incViewCount( $id ) {
3587 $id = intval( $id );
3588 global $wgHitcounterUpdateFreq, $wgDBtype;
3590 $dbw = wfGetDB( DB_MASTER
);
3591 $pageTable = $dbw->tableName( 'page' );
3592 $hitcounterTable = $dbw->tableName( 'hitcounter' );
3593 $acchitsTable = $dbw->tableName( 'acchits' );
3595 if( $wgHitcounterUpdateFreq <= 1 ) {
3596 $dbw->query( "UPDATE $pageTable SET page_counter = page_counter + 1 WHERE page_id = $id" );
3600 # Not important enough to warrant an error page in case of failure
3601 $oldignore = $dbw->ignoreErrors( true );
3603 $dbw->query( "INSERT INTO $hitcounterTable (hc_id) VALUES ({$id})" );
3605 $checkfreq = intval( $wgHitcounterUpdateFreq/25 +
1 );
3606 if( (rand() %
$checkfreq != 0) or ($dbw->lastErrno() != 0) ){
3607 # Most of the time (or on SQL errors), skip row count check
3608 $dbw->ignoreErrors( $oldignore );
3612 $res = $dbw->query("SELECT COUNT(*) as n FROM $hitcounterTable");
3613 $row = $dbw->fetchObject( $res );
3614 $rown = intval( $row->n
);
3615 if( $rown >= $wgHitcounterUpdateFreq ){
3616 wfProfileIn( 'Article::incViewCount-collect' );
3617 $old_user_abort = ignore_user_abort( true );
3619 if($wgDBtype == 'mysql')
3620 $dbw->query("LOCK TABLES $hitcounterTable WRITE");
3621 $tabletype = $wgDBtype == 'mysql' ?
"ENGINE=HEAP " : '';
3622 $dbw->query("CREATE TEMPORARY TABLE $acchitsTable $tabletype AS ".
3623 "SELECT hc_id,COUNT(*) AS hc_n FROM $hitcounterTable ".
3625 $dbw->query("DELETE FROM $hitcounterTable");
3626 if($wgDBtype == 'mysql') {
3627 $dbw->query('UNLOCK TABLES');
3628 $dbw->query("UPDATE $pageTable,$acchitsTable SET page_counter=page_counter + hc_n ".
3629 'WHERE page_id = hc_id');
3632 $dbw->query("UPDATE $pageTable SET page_counter=page_counter + hc_n ".
3633 "FROM $acchitsTable WHERE page_id = hc_id");
3635 $dbw->query("DROP TABLE $acchitsTable");
3637 ignore_user_abort( $old_user_abort );
3638 wfProfileOut( 'Article::incViewCount-collect' );
3640 $dbw->ignoreErrors( $oldignore );
3644 * The onArticle*() functions are supposed to be a kind of hooks
3645 * which should be called whenever any of the specified actions
3648 * This is a good place to put code to clear caches, for instance.
3650 * This is called on page move and undelete, as well as edit
3652 * @param $title a title object
3655 public static function onArticleCreate( $title ) {
3656 # Update existence markers on article/talk tabs...
3657 if( $title->isTalkPage() ) {
3658 $other = $title->getSubjectPage();
3660 $other = $title->getTalkPage();
3662 $other->invalidateCache();
3663 $other->purgeSquid();
3665 $title->touchLinks();
3666 $title->purgeSquid();
3667 $title->deleteTitleProtection();
3670 public static function onArticleDelete( $title ) {
3671 global $wgMessageCache;
3672 # Update existence markers on article/talk tabs...
3673 if( $title->isTalkPage() ) {
3674 $other = $title->getSubjectPage();
3676 $other = $title->getTalkPage();
3678 $other->invalidateCache();
3679 $other->purgeSquid();
3681 $title->touchLinks();
3682 $title->purgeSquid();
3685 HTMLFileCache
::clearFileCache( $title );
3688 if( $title->getNamespace() == NS_MEDIAWIKI
) {
3689 $wgMessageCache->replace( $title->getDBkey(), false );
3692 if( $title->getNamespace() == NS_FILE
) {
3693 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
3694 $update->doUpdate();
3697 if( $title->getNamespace() == NS_USER_TALK
) {
3698 $user = User
::newFromName( $title->getText(), false );
3699 $user->setNewtalk( false );
3702 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3706 * Purge caches on page update etc
3708 public static function onArticleEdit( $title, $flags = '' ) {
3709 global $wgDeferredUpdateList;
3711 // Invalidate caches of articles which include this page
3712 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'templatelinks' );
3714 // Invalidate the caches of all pages which redirect here
3715 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'redirect' );
3717 # Purge squid for this page only
3718 $title->purgeSquid();
3720 # Clear file cache for this page only
3721 HTMLFileCache
::clearFileCache( $title );
3727 * Overriden by ImagePage class, only present here to avoid a fatal error
3728 * Called for ?action=revert
3730 public function revert() {
3732 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
3736 * Info about this page
3737 * Called for ?action=info when $wgAllowPageInfo is on.
3739 public function info() {
3740 global $wgLang, $wgOut, $wgAllowPageInfo, $wgUser;
3742 if( !$wgAllowPageInfo ) {
3743 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
3747 $page = $this->mTitle
->getSubjectPage();
3749 $wgOut->setPagetitle( $page->getPrefixedText() );
3750 $wgOut->setPageTitleActionText( wfMsg( 'info_short' ) );
3751 $wgOut->setSubtitle( wfMsgHtml( 'infosubtitle' ) );
3753 if( !$this->mTitle
->exists() ) {
3754 $wgOut->addHTML( '<div class="noarticletext">' );
3755 if( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
3756 // This doesn't quite make sense; the user is asking for
3757 // information about the _page_, not the message... -- RC
3758 $wgOut->addHTML( htmlspecialchars( wfMsgWeirdKey( $this->mTitle
->getText() ) ) );
3760 $msg = $wgUser->isLoggedIn()
3762 : 'noarticletextanon';
3763 $wgOut->addHTML( wfMsgExt( $msg, 'parse' ) );
3765 $wgOut->addHTML( '</div>' );
3767 $dbr = wfGetDB( DB_SLAVE
);
3769 'wl_title' => $page->getDBkey(),
3770 'wl_namespace' => $page->getNamespace() );
3771 $numwatchers = $dbr->selectField(
3776 $this->getSelectOptions() );
3778 $pageInfo = $this->pageCountInfo( $page );
3779 $talkInfo = $this->pageCountInfo( $page->getTalkPage() );
3781 $wgOut->addHTML( "<ul><li>" . wfMsg("numwatchers", $wgLang->formatNum( $numwatchers ) ) . '</li>' );
3782 $wgOut->addHTML( "<li>" . wfMsg('numedits', $wgLang->formatNum( $pageInfo['edits'] ) ) . '</li>');
3784 $wgOut->addHTML( '<li>' . wfMsg("numtalkedits", $wgLang->formatNum( $talkInfo['edits'] ) ) . '</li>');
3786 $wgOut->addHTML( '<li>' . wfMsg("numauthors", $wgLang->formatNum( $pageInfo['authors'] ) ) . '</li>' );
3788 $wgOut->addHTML( '<li>' . wfMsg('numtalkauthors', $wgLang->formatNum( $talkInfo['authors'] ) ) . '</li>' );
3790 $wgOut->addHTML( '</ul>' );
3795 * Return the total number of edits and number of unique editors
3796 * on a given page. If page does not exist, returns false.
3798 * @param $title Title object
3801 public function pageCountInfo( $title ) {
3802 $id = $title->getArticleId();
3806 $dbr = wfGetDB( DB_SLAVE
);
3807 $rev_clause = array( 'rev_page' => $id );
3808 $edits = $dbr->selectField(
3813 $this->getSelectOptions()
3815 $authors = $dbr->selectField(
3817 'COUNT(DISTINCT rev_user_text)',
3820 $this->getSelectOptions()
3822 return array( 'edits' => $edits, 'authors' => $authors );
3826 * Return a list of templates used by this article.
3827 * Uses the templatelinks table
3829 * @return Array of Title objects
3831 public function getUsedTemplates() {
3833 $id = $this->mTitle
->getArticleID();
3837 $dbr = wfGetDB( DB_SLAVE
);
3838 $res = $dbr->select( array( 'templatelinks' ),
3839 array( 'tl_namespace', 'tl_title' ),
3840 array( 'tl_from' => $id ),
3842 if( $res !== false ) {
3843 foreach( $res as $row ) {
3844 $result[] = Title
::makeTitle( $row->tl_namespace
, $row->tl_title
);
3847 $dbr->freeResult( $res );
3852 * Returns a list of hidden categories this page is a member of.
3853 * Uses the page_props and categorylinks tables.
3855 * @return Array of Title objects
3857 public function getHiddenCategories() {
3859 $id = $this->mTitle
->getArticleID();
3863 $dbr = wfGetDB( DB_SLAVE
);
3864 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
3866 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3867 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to'),
3869 if( $res !== false ) {
3870 foreach( $res as $row ) {
3871 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
3874 $dbr->freeResult( $res );
3879 * Return an applicable autosummary if one exists for the given edit.
3880 * @param $oldtext String: the previous text of the page.
3881 * @param $newtext String: The submitted text of the page.
3882 * @param $flags Bitmask: a bitmask of flags submitted for the edit.
3883 * @return string An appropriate autosummary, or an empty string.
3885 public static function getAutosummary( $oldtext, $newtext, $flags ) {
3886 # Decide what kind of autosummary is needed.
3888 # Redirect autosummaries
3889 $ot = Title
::newFromRedirect( $oldtext );
3890 $rt = Title
::newFromRedirect( $newtext );
3891 if( is_object( $rt ) && ( !is_object( $ot ) ||
!$rt->equals( $ot ) ||
$ot->getFragment() != $rt->getFragment() ) ) {
3892 return wfMsgForContent( 'autoredircomment', $rt->getFullText() );
3895 # New page autosummaries
3896 if( $flags & EDIT_NEW
&& strlen( $newtext ) ) {
3897 # If they're making a new article, give its text, truncated, in the summary.
3899 $truncatedtext = $wgContLang->truncate(
3900 str_replace("\n", ' ', $newtext),
3901 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
3902 return wfMsgForContent( 'autosumm-new', $truncatedtext );
3905 # Blanking autosummaries
3906 if( $oldtext != '' && $newtext == '' ) {
3907 return wfMsgForContent( 'autosumm-blank' );
3908 } elseif( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500) {
3909 # Removing more than 90% of the article
3911 $truncatedtext = $wgContLang->truncate(
3913 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
3914 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
3917 # If we reach this point, there's no applicable autosummary for our case, so our
3918 # autosummary is empty.
3923 * Add the primary page-view wikitext to the output buffer
3924 * Saves the text into the parser cache if possible.
3925 * Updates templatelinks if it is out of date.
3927 * @param $text String
3928 * @param $cache Boolean
3930 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
3933 $this->mParserOutput
= $this->getOutputFromWikitext( $text, $cache, $parserOptions );
3934 $wgOut->addParserOutput( $this->mParserOutput
);
3938 * This does all the heavy lifting for outputWikitext, except it returns the parser
3939 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
3940 * say, embedding thread pages within a discussion system (LiquidThreads)
3942 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
3943 global $wgParser, $wgOut, $wgEnableParserCache, $wgUseFileCache;
3945 if ( !$parserOptions ) {
3946 $parserOptions = $this->getParserOptions();
3950 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
,
3951 $parserOptions, true, true, $this->getRevIdFetched() );
3956 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
3957 $this->mTitle
->getPrefixedDBkey()));
3960 if( $wgEnableParserCache && $cache && $this && $this->mParserOutput
->getCacheTime() != -1 ) {
3961 $parserCache = ParserCache
::singleton();
3962 $parserCache->save( $this->mParserOutput
, $this, $parserOptions );
3964 // Make sure file cache is not used on uncacheable content.
3965 // Output that has magic words in it can still use the parser cache
3966 // (if enabled), though it will generally expire sooner.
3967 if( $this->mParserOutput
->getCacheTime() == -1 ||
$this->mParserOutput
->containsOldMagic() ) {
3968 $wgUseFileCache = false;
3970 $this->doCascadeProtectionUpdates( $this->mParserOutput
);
3971 return $this->mParserOutput
;
3975 * Get parser options suitable for rendering the primary article wikitext
3977 public function getParserOptions() {
3979 if ( !$this->mParserOptions
) {
3980 $this->mParserOptions
= new ParserOptions( $wgUser );
3981 $this->mParserOptions
->setTidy( true );
3982 $this->mParserOptions
->enableLimitReport();
3984 return $this->mParserOptions
;
3987 protected function doCascadeProtectionUpdates( $parserOutput ) {
3988 if( !$this->isCurrent() ||
wfReadOnly() ||
!$this->mTitle
->areRestrictionsCascading() ) {
3992 // templatelinks table may have become out of sync,
3993 // especially if using variable-based transclusions.
3994 // For paranoia, check if things have changed and if
3995 // so apply updates to the database. This will ensure
3996 // that cascaded protections apply as soon as the changes
3999 # Get templates from templatelinks
4000 $id = $this->mTitle
->getArticleID();
4002 $tlTemplates = array();
4004 $dbr = wfGetDB( DB_SLAVE
);
4005 $res = $dbr->select( array( 'templatelinks' ),
4006 array( 'tl_namespace', 'tl_title' ),
4007 array( 'tl_from' => $id ),
4011 foreach( $res as $row ) {
4012 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
4015 # Get templates from parser output.
4016 $poTemplates = array();
4017 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
4018 foreach ( $templates as $dbk => $id ) {
4019 $poTemplates["$ns:$dbk"] = true;
4024 # Note that we simulate array_diff_key in PHP <5.0.x
4025 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
4027 if( count( $templates_diff ) > 0 ) {
4028 # Whee, link updates time.
4029 $u = new LinksUpdate( $this->mTitle
, $parserOutput, false );
4035 * Update all the appropriate counts in the category table, given that
4036 * we've added the categories $added and deleted the categories $deleted.
4038 * @param $added array The names of categories that were added
4039 * @param $deleted array The names of categories that were deleted
4042 public function updateCategoryCounts( $added, $deleted ) {
4043 $ns = $this->mTitle
->getNamespace();
4044 $dbw = wfGetDB( DB_MASTER
);
4046 # First make sure the rows exist. If one of the "deleted" ones didn't
4047 # exist, we might legitimately not create it, but it's simpler to just
4048 # create it and then give it a negative value, since the value is bogus
4051 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
4052 $insertCats = array_merge( $added, $deleted );
4053 if( !$insertCats ) {
4054 # Okay, nothing to do
4057 $insertRows = array();
4058 foreach( $insertCats as $cat ) {
4059 $insertRows[] = array( 'cat_title' => $cat );
4061 $dbw->insert( 'category', $insertRows, __METHOD__
, 'IGNORE' );
4063 $addFields = array( 'cat_pages = cat_pages + 1' );
4064 $removeFields = array( 'cat_pages = cat_pages - 1' );
4065 if( $ns == NS_CATEGORY
) {
4066 $addFields[] = 'cat_subcats = cat_subcats + 1';
4067 $removeFields[] = 'cat_subcats = cat_subcats - 1';
4068 } elseif( $ns == NS_FILE
) {
4069 $addFields[] = 'cat_files = cat_files + 1';
4070 $removeFields[] = 'cat_files = cat_files - 1';
4077 array( 'cat_title' => $added ),
4085 array( 'cat_title' => $deleted ),
4091 /** Lightweight method to get the parser output for a page, checking the parser cache
4092 * and so on. Doesn't consider most of the stuff that Article::view is forced to
4093 * consider, so it's not appropriate to use there. */
4094 function getParserOutput( $oldid = null ) {
4095 global $wgEnableParserCache, $wgUser, $wgOut;
4097 // Should the parser cache be used?
4098 $useParserCache = $wgEnableParserCache &&
4099 intval( $wgUser->getOption( 'stubthreshold' ) ) == 0 &&
4103 wfDebug( __METHOD__
.': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
4104 if ( $wgUser->getOption( 'stubthreshold' ) ) {
4105 wfIncrStats( 'pcache_miss_stub' );
4108 $parserOutput = false;
4109 if ( $useParserCache ) {
4110 $parserOutput = ParserCache
::singleton()->get( $this, $this->getParserOptions() );
4113 if ( $parserOutput === false ) {
4114 // Cache miss; parse and output it.
4115 $rev = Revision
::newFromTitle( $this->getTitle(), $oldid );
4117 return $this->getOutputFromWikitext( $rev->getText(), $useParserCache );
4119 return $parserOutput;